ClientRequestServerCreateViewData.java

//   Copyright 2004-2014 Jim Voris
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//
package com.qumasoft.qvcslib.requestdata;

import java.util.Date;

/**
 * Create view request data.
 * @author Jim Voris
 */
public class ClientRequestServerCreateViewData extends ClientRequestClientData {
    private static final long serialVersionUID = 8477594120551146914L;

    private static final ValidRequestElementType[] VALID_ELEMENTS = {
        ValidRequestElementType.SERVER_NAME,
        ValidRequestElementType.PROJECT_NAME,
        ValidRequestElementType.VIEW_NAME,
        ValidRequestElementType.USER_NAME
    };

    private boolean isReadOnlyViewFlag = false;
    private boolean isDateBasedViewFlag = false;
    private boolean isTranslucentBranchFlag = false;
    private boolean isOpaqueBranchFlag = false;
    private Date dateBasedDate = null;
    private String dateBasedViewBranch = null;
    private String parentBranchName = null;

    /**
     * Creates a new instance of ClientRequestServerCreateViewData.
     */
    public ClientRequestServerCreateViewData() {
    }

    /**
     * Get the is read only type of view flag.
     * @return the is read only type of view flag.
     */
    public boolean getIsReadOnlyViewFlag() {
        return isReadOnlyViewFlag;
    }

    /**
     * Set the is read only type of view flag.
     * @param flag the is read only type of view flag.
     */
    public void setIsReadOnlyViewFlag(boolean flag) {
        this.isReadOnlyViewFlag = flag;
    }

    /**
     * Get the is this a date based view flag.
     * @return the is this a date based view flag.
     */
    public boolean getIsDateBasedViewFlag() {
        return isDateBasedViewFlag;
    }

    /**
     * Set the is this a date based view flag.
     * @param flag the is this a date based view flag.
     */
    public void setIsDateBasedViewFlag(boolean flag) {
        this.isDateBasedViewFlag = flag;
    }

    /**
     * Get is this a translucent branch flag.
     * @return is this a translucent branch flag.
     */
    public boolean getIsTranslucentBranchFlag() {
        return isTranslucentBranchFlag;
    }

    /**
     * Set is this a translucent branch flag.
     * @param flag is this a translucent branch flag.
     */
    public void setIsTranslucentBranchFlag(boolean flag) {
        this.isTranslucentBranchFlag = flag;
    }

    /**
     * Get is this an opaque branch flag.
     * @return is this an opaque branch flag.
     */
    public boolean getIsOpaqueBranchFlag() {
        return isOpaqueBranchFlag;
    }

    /**
     * Set is this an opaque branch flag.
     * @param flag is this an opaque branch flag.
     */
    public void setIsOpaqueBranchFlag(boolean flag) {
        this.isOpaqueBranchFlag = flag;
    }

    /**
     * Get the date-based anchor date.
     * @return the date-based anchor date.
     */
    public Date getDateBasedDate() {
        return dateBasedDate;
    }

    /**
     * Set the date-based anchor date.
     * @param date the date-based anchor date.
     */
    public void setDateBasedDate(Date date) {
        this.dateBasedDate = date;
    }

    /**
     * Get the date based view branch.
     * @return the date based view branch.
     */
    public String getDateBasedViewBranch() {
        return dateBasedViewBranch;
    }

    /**
     * Set the date based view branch.
     * @param branch the date based view branch.
     */
    public void setDateBasedViewBranch(final String branch) {
        this.dateBasedViewBranch = branch;
    }

    /**
     * Get the parent branch name.
     * @return the parent branch name.
     */
    public String getParentBranchName() {
        return parentBranchName;
    }

    /**
     * Set the parent branch name.
     * @param parentBranch the parent branch name.
     */
    public void setParentBranchName(final String parentBranch) {
        this.parentBranchName = parentBranch;
    }

    @Override
    public RequestOperationType getOperationType() {
        return RequestOperationType.SERVER_CREATE_VIEW;
    }

    @Override
    public ValidRequestElementType[] getValidElements() {
        return VALID_ELEMENTS;
    }
}