// --------------------------------------------------------------------------------
// Copyright 2002-2024 Echo Three, LLC
//
// 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.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * UserVisitCommand.java
 */

package com.echothree.model.data.user.server.entity;

import com.echothree.model.data.user.common.pk.UserVisitCommandPK;

import com.echothree.model.data.user.common.pk.UserVisitPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.core.common.pk.CommandPK;

import com.echothree.model.data.user.server.entity.UserVisit;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.core.server.entity.Command;

import com.echothree.model.data.user.server.factory.UserVisitFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.core.server.factory.CommandFactory;

import com.echothree.model.data.user.common.pk.UserVisitCommandPK;

import com.echothree.model.data.user.server.value.UserVisitCommandValue;

import com.echothree.model.data.user.server.factory.UserVisitCommandFactory;

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

public class UserVisitCommand
        extends BaseEntity
        implements Serializable {
    
    private UserVisitCommandPK _pk;
    private UserVisitCommandValue _value;
    
    /** Creates a new instance of UserVisitCommand */
    public UserVisitCommand()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserVisitCommand */
    public UserVisitCommand(UserVisitCommandValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public UserVisitCommandFactory getBaseFactoryInstance() {
        return UserVisitCommandFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof UserVisitCommand) {
            UserVisitCommand that = (UserVisitCommand)other;
            
            UserVisitCommandValue thatValue = that.getUserVisitCommandValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(session, this);
    }
    
    @Override
    public void remove(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(session, this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
    }
    
    public UserVisitCommandValue getUserVisitCommandValue() {
        return _value;
    }
    
    public void setUserVisitCommandValue(UserVisitCommandValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public UserVisitCommandPK getPrimaryKey() {
        return _pk;
    }
    
    public UserVisitPK getUserVisitPK() {
        return _value.getUserVisitPK();
    }
    
    public UserVisit getUserVisit(Session session, EntityPermission entityPermission) {
        return UserVisitFactory.getInstance().getEntityFromPK(session, entityPermission, getUserVisitPK());
    }
    
    public UserVisit getUserVisit(EntityPermission entityPermission) {
        return getUserVisit(ThreadSession.currentSession(), entityPermission);
    }
    
    public UserVisit getUserVisit(Session session) {
        return getUserVisit(session, EntityPermission.READ_ONLY);
    }
    
    public UserVisit getUserVisit() {
        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public UserVisit getUserVisitForUpdate(Session session) {
        return getUserVisit(session, EntityPermission.READ_WRITE);
    }
    
    public UserVisit getUserVisitForUpdate() {
        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setUserVisitPK(UserVisitPK userVisitPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitPK(userVisitPK);
    }
    
    public void setUserVisit(UserVisit entity) {
        setUserVisitPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getUserVisitPKHasBeenModified() {
        return _value.getUserVisitPKHasBeenModified();
    }
    
    public Integer getUserVisitCommandSequence() {
        return _value.getUserVisitCommandSequence();
    }
    
    public void setUserVisitCommandSequence(Integer userVisitCommandSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitCommandSequence(userVisitCommandSequence);
    }
    
    public boolean getUserVisitCommandSequenceHasBeenModified() {
        return _value.getUserVisitCommandSequenceHasBeenModified();
    }
    
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    public Party getParty(Session session, EntityPermission entityPermission) {
        PartyPK pk = getPartyPK();
        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
        
        return entity;
    }
    
    public Party getParty(EntityPermission entityPermission) {
        return getParty(ThreadSession.currentSession(), entityPermission);
    }
    
    public Party getParty(Session session) {
        return getParty(session, EntityPermission.READ_ONLY);
    }
    
    public Party getParty() {
        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Party getPartyForUpdate(Session session) {
        return getParty(session, EntityPermission.READ_WRITE);
    }
    
    public Party getPartyForUpdate() {
        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(Party entity) {
        setPartyPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    public CommandPK getCommandPK() {
        return _value.getCommandPK();
    }
    
    public Command getCommand(Session session, EntityPermission entityPermission) {
        return CommandFactory.getInstance().getEntityFromPK(session, entityPermission, getCommandPK());
    }
    
    public Command getCommand(EntityPermission entityPermission) {
        return getCommand(ThreadSession.currentSession(), entityPermission);
    }
    
    public Command getCommand(Session session) {
        return getCommand(session, EntityPermission.READ_ONLY);
    }
    
    public Command getCommand() {
        return getCommand(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Command getCommandForUpdate(Session session) {
        return getCommand(session, EntityPermission.READ_WRITE);
    }
    
    public Command getCommandForUpdate() {
        return getCommand(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setCommandPK(CommandPK commandPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommandPK(commandPK);
    }
    
    public void setCommand(Command entity) {
        setCommandPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getCommandPKHasBeenModified() {
        return _value.getCommandPKHasBeenModified();
    }
    
    public Long getStartTime() {
        return _value.getStartTime();
    }
    
    public void setStartTime(Long startTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStartTime(startTime);
    }
    
    public boolean getStartTimeHasBeenModified() {
        return _value.getStartTimeHasBeenModified();
    }
    
    public Long getEndTime() {
        return _value.getEndTime();
    }
    
    public void setEndTime(Long endTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEndTime(endTime);
    }
    
    public boolean getEndTimeHasBeenModified() {
        return _value.getEndTimeHasBeenModified();
    }
    
    public Boolean getHadSecurityErrors() {
        return _value.getHadSecurityErrors();
    }
    
    public void setHadSecurityErrors(Boolean hadSecurityErrors)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHadSecurityErrors(hadSecurityErrors);
    }
    
    public boolean getHadSecurityErrorsHasBeenModified() {
        return _value.getHadSecurityErrorsHasBeenModified();
    }
    
    public Boolean getHadValidationErrors() {
        return _value.getHadValidationErrors();
    }
    
    public void setHadValidationErrors(Boolean hadValidationErrors)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHadValidationErrors(hadValidationErrors);
    }
    
    public boolean getHadValidationErrorsHasBeenModified() {
        return _value.getHadValidationErrorsHasBeenModified();
    }
    
    public Boolean getHadExecutionErrors() {
        return _value.getHadExecutionErrors();
    }
    
    public void setHadExecutionErrors(Boolean hadExecutionErrors)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHadExecutionErrors(hadExecutionErrors);
    }
    
    public boolean getHadExecutionErrorsHasBeenModified() {
        return _value.getHadExecutionErrorsHasBeenModified();
    }
    
}