// --------------------------------------------------------------------------------
// Copyright 2002-2026 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
// --------------------------------------------------------------------------------

/**
 * Profile.java
 */

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

import com.echothree.model.data.party.common.pk.ProfilePK;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.icon.common.pk.IconPK;
import com.echothree.model.data.party.common.pk.GenderPK;
import com.echothree.model.data.party.common.pk.BirthdayFormatPK;
import com.echothree.model.data.core.common.pk.MimeTypePK;

import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.icon.server.entity.Icon;
import com.echothree.model.data.party.server.entity.Gender;
import com.echothree.model.data.party.server.entity.BirthdayFormat;
import com.echothree.model.data.core.server.entity.MimeType;

import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.icon.server.factory.IconFactory;
import com.echothree.model.data.party.server.factory.GenderFactory;
import com.echothree.model.data.party.server.factory.BirthdayFormatFactory;
import com.echothree.model.data.core.server.factory.MimeTypeFactory;

import com.echothree.model.data.party.common.pk.ProfilePK;

import com.echothree.model.data.party.server.value.ProfileValue;

import com.echothree.model.data.party.server.factory.ProfileFactory;

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;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class Profile
        extends BaseEntity
        implements Serializable {
    
    private ProfilePK _pk;
    private ProfileValue _value;
    
    /** Creates a new instance of Profile */
    public Profile()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Profile */
    public Profile(ProfileValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ProfileFactory getBaseFactoryInstance() {
        return ProfileFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof Profile that) {
            ProfileValue thatValue = that.getProfileValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public ProfileValue getProfileValue() {
        return _value;
    }
    
    public void setProfileValue(@Nonnull ProfileValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ProfilePK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nonnull
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    @Nonnull
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nonnull Party entity) {
        setPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    @Nullable
    public String getNickname() {
        return _value.getNickname();
    }
    
    public void setNickname(@Nullable String nickname)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setNickname(nickname);
    }
    
    public boolean getNicknameHasBeenModified() {
        return _value.getNicknameHasBeenModified();
    }
    
    @Nullable
    public IconPK getIconPK() {
        return _value.getIconPK();
    }
    
    @Nullable
    public Icon getIcon(EntityPermission entityPermission) {
        IconPK pk = getIconPK();
        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Icon getIcon() {
        return getIcon(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Icon getIconForUpdate() {
        return getIcon(EntityPermission.READ_WRITE);
    }
    
    public void setIconPK(@Nullable IconPK iconPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIconPK(iconPK);
    }
    
    public void setIcon(@Nullable Icon entity) {
        setIconPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getIconPKHasBeenModified() {
        return _value.getIconPKHasBeenModified();
    }
    
    @Nullable
    public String getPronunciation() {
        return _value.getPronunciation();
    }
    
    public void setPronunciation(@Nullable String pronunciation)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPronunciation(pronunciation);
    }
    
    public boolean getPronunciationHasBeenModified() {
        return _value.getPronunciationHasBeenModified();
    }
    
    @Nullable
    public GenderPK getGenderPK() {
        return _value.getGenderPK();
    }
    
    @Nullable
    public Gender getGender(EntityPermission entityPermission) {
        GenderPK pk = getGenderPK();
        Gender entity = pk == null? null: GenderFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Gender getGender() {
        return getGender(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Gender getGenderForUpdate() {
        return getGender(EntityPermission.READ_WRITE);
    }
    
    public void setGenderPK(@Nullable GenderPK genderPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGenderPK(genderPK);
    }
    
    public void setGender(@Nullable Gender entity) {
        setGenderPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGenderPKHasBeenModified() {
        return _value.getGenderPKHasBeenModified();
    }
    
    @Nullable
    public String getPronouns() {
        return _value.getPronouns();
    }
    
    public void setPronouns(@Nullable String pronouns)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPronouns(pronouns);
    }
    
    public boolean getPronounsHasBeenModified() {
        return _value.getPronounsHasBeenModified();
    }
    
    @Nullable
    public Integer getBirthday() {
        return _value.getBirthday();
    }
    
    public void setBirthday(@Nullable Integer birthday)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBirthday(birthday);
    }
    
    public boolean getBirthdayHasBeenModified() {
        return _value.getBirthdayHasBeenModified();
    }
    
    @Nonnull
    public BirthdayFormatPK getBirthdayFormatPK() {
        return _value.getBirthdayFormatPK();
    }
    
    @Nonnull
    public BirthdayFormat getBirthdayFormat(EntityPermission entityPermission) {
        return BirthdayFormatFactory.getInstance().getEntityFromPK(entityPermission, getBirthdayFormatPK());
    }
    
    @Nonnull
    public BirthdayFormat getBirthdayFormat() {
        return getBirthdayFormat(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public BirthdayFormat getBirthdayFormatForUpdate() {
        return getBirthdayFormat(EntityPermission.READ_WRITE);
    }
    
    public void setBirthdayFormatPK(@Nonnull BirthdayFormatPK birthdayFormatPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBirthdayFormatPK(birthdayFormatPK);
    }
    
    public void setBirthdayFormat(@Nonnull BirthdayFormat entity) {
        setBirthdayFormatPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBirthdayFormatPKHasBeenModified() {
        return _value.getBirthdayFormatPKHasBeenModified();
    }
    
    @Nullable
    public String getOccupation() {
        return _value.getOccupation();
    }
    
    public void setOccupation(@Nullable String occupation)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOccupation(occupation);
    }
    
    public boolean getOccupationHasBeenModified() {
        return _value.getOccupationHasBeenModified();
    }
    
    @Nullable
    public String getHobbies() {
        return _value.getHobbies();
    }
    
    public void setHobbies(@Nullable String hobbies)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHobbies(hobbies);
    }
    
    public boolean getHobbiesHasBeenModified() {
        return _value.getHobbiesHasBeenModified();
    }
    
    @Nullable
    public String getLocation() {
        return _value.getLocation();
    }
    
    public void setLocation(@Nullable String location)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLocation(location);
    }
    
    public boolean getLocationHasBeenModified() {
        return _value.getLocationHasBeenModified();
    }
    
    @Nullable
    public MimeTypePK getBioMimeTypePK() {
        return _value.getBioMimeTypePK();
    }
    
    @Nullable
    public MimeType getBioMimeType(EntityPermission entityPermission) {
        MimeTypePK pk = getBioMimeTypePK();
        MimeType entity = pk == null? null: MimeTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public MimeType getBioMimeType() {
        return getBioMimeType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public MimeType getBioMimeTypeForUpdate() {
        return getBioMimeType(EntityPermission.READ_WRITE);
    }
    
    public void setBioMimeTypePK(@Nullable MimeTypePK bioMimeTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBioMimeTypePK(bioMimeTypePK);
    }
    
    public void setBioMimeType(@Nullable MimeType entity) {
        setBioMimeTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBioMimeTypePKHasBeenModified() {
        return _value.getBioMimeTypePKHasBeenModified();
    }
    
    @Nullable
    public String getBio() {
        return _value.getBio();
    }
    
    public void setBio(@Nullable String bio)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBio(bio);
    }
    
    public boolean getBioHasBeenModified() {
        return _value.getBioHasBeenModified();
    }
    
    @Nullable
    public MimeTypePK getSignatureMimeTypePK() {
        return _value.getSignatureMimeTypePK();
    }
    
    @Nullable
    public MimeType getSignatureMimeType(EntityPermission entityPermission) {
        MimeTypePK pk = getSignatureMimeTypePK();
        MimeType entity = pk == null? null: MimeTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public MimeType getSignatureMimeType() {
        return getSignatureMimeType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public MimeType getSignatureMimeTypeForUpdate() {
        return getSignatureMimeType(EntityPermission.READ_WRITE);
    }
    
    public void setSignatureMimeTypePK(@Nullable MimeTypePK signatureMimeTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSignatureMimeTypePK(signatureMimeTypePK);
    }
    
    public void setSignatureMimeType(@Nullable MimeType entity) {
        setSignatureMimeTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSignatureMimeTypePKHasBeenModified() {
        return _value.getSignatureMimeTypePKHasBeenModified();
    }
    
    @Nullable
    public String getSignature() {
        return _value.getSignature();
    }
    
    public void setSignature(@Nullable String signature)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSignature(signature);
    }
    
    public boolean getSignatureHasBeenModified() {
        return _value.getSignatureHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}