// --------------------------------------------------------------------------------
// 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
// --------------------------------------------------------------------------------

/**
 * PartyDocument.java
 */

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

import com.echothree.model.data.document.common.pk.PartyDocumentPK;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.document.common.pk.DocumentPK;

import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.document.server.entity.Document;

import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.document.server.factory.DocumentFactory;

import com.echothree.model.data.document.common.pk.PartyDocumentPK;

import com.echothree.model.data.document.server.value.PartyDocumentValue;

import com.echothree.model.data.document.server.factory.PartyDocumentFactory;

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 PartyDocument
        extends BaseEntity
        implements Serializable {
    
    private PartyDocumentPK _pk;
    private PartyDocumentValue _value;
    
    /** Creates a new instance of PartyDocument */
    public PartyDocument()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PartyDocument */
    public PartyDocument(PartyDocumentValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public PartyDocumentFactory getBaseFactoryInstance() {
        return PartyDocumentFactory.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 PartyDocument) {
            PartyDocument that = (PartyDocument)other;
            
            PartyDocumentValue thatValue = that.getPartyDocumentValue();
            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 PartyDocumentValue getPartyDocumentValue() {
        return _value;
    }
    
    public void setPartyDocumentValue(PartyDocumentValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public PartyDocumentPK getPrimaryKey() {
        return _pk;
    }
    
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    public Party getParty(Session session, EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getPartyPK());
    }
    
    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 DocumentPK getDocumentPK() {
        return _value.getDocumentPK();
    }
    
    public Document getDocument(Session session, EntityPermission entityPermission) {
        return DocumentFactory.getInstance().getEntityFromPK(session, entityPermission, getDocumentPK());
    }
    
    public Document getDocument(EntityPermission entityPermission) {
        return getDocument(ThreadSession.currentSession(), entityPermission);
    }
    
    public Document getDocument(Session session) {
        return getDocument(session, EntityPermission.READ_ONLY);
    }
    
    public Document getDocument() {
        return getDocument(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Document getDocumentForUpdate(Session session) {
        return getDocument(session, EntityPermission.READ_WRITE);
    }
    
    public Document getDocumentForUpdate() {
        return getDocument(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setDocumentPK(DocumentPK documentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDocumentPK(documentPK);
    }
    
    public void setDocument(Document entity) {
        setDocumentPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getDocumentPKHasBeenModified() {
        return _value.getDocumentPKHasBeenModified();
    }
    
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}