psdi.common.role

Class MaxRole

java.lang.Object

psdi.mbo.Mbo

psdi.common.role.MaxRole

All Implemented Interfaces:

java.rmi.Remote, MaxRoleRemote, MboConstants, MboRemote, MaxRemoteProxy

public class MaxRole
extends Mbo
implements MaxRoleRemote

A role stands in for a person or people or just email addresses. Resolving a role returns a MboSet of Person which may contain one or many records. Some roles can only be resolved to email addresses. All roles that resolve to Person records can also resolve to email addresses of those people. There are a number of ways to set how the role will be resolved. The type of the role determines role resolution.

This is a system level object.

The key attribute for this object is MaxRole .

The attributes in this object are as follows:

Attribute Name	Description
Type	Type of the role. Valid types are PERSON, PERSONGROUP, CUSTOM, DATASET, USERDATA, EMAILADDRESS. These values are defined in the domain RoleType.
Value	Role definition. When Type is PERSON, value is a Person Identifier. The role resolves to a single person. When Type is PERSONGROUP, value is PersonGroup Identifier. The role is resolved using the person group and the IsBroadcast flag. When Type is CUSTOM, value is the name of a custom role class which implements the CustomRoleInterface. The return of this class is treated as if PersonID or PersonGroup was set, depending on the type of Mbo returned. When Type is DATASET, value consists of a dot-notation relationship (optional) and an attribute name of the current object which is used to generates a list of Person ids or email addresses. When Type is USERDATA, value consists of a dot-notatjion relationship (optional) and an attribute name of the login user which generates a list of Person Ids or email addresses. When Type is EMAILADDRESS, value consists an email address.
Description	Role description.
IsBroadcast	When set, all primary members of a person group are included in the role resolution, otherwise only the current responsible person is included.
IsEmailDataSet	When set, this value says the value represent email addresses, not PersonIDs. Also when set, the role is only resolveable to email addresses.
ObjectName	Name of the object this role works with. If null, this role is available for use with all objects. This attribute is required for DataSet roles.
Parameter	Used to pass additional information to the object created when a role with a classname is evaluated.
MaxRole	Unique identifier of this role.

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
MaxRole(MboSet ms) Construct the MaxRole object

Method Summary

Modifier and Type	Method and Description
void	canDelete() Can the object be deleted ? This is object specific and should be overridden.
MboRemote	duplicate() Duplicate method only throws exception now
PersonSetRemote	getGroupPeople(PersonGroupRemote group, MboRemote mbo) Return the set of Person based upon the group and the IsBroadcast flag.
PersonSetRemote	getGroupPeople(PersonGroupRemote group, MboRemote mbo, boolean treatNoCalAsAvailable)
PersonSetRemote	getPerson(java.lang.String pid) Fetches the Person Mbo for a PersonID.
java.lang.String	getType() Returns the role's type.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
boolean	isAttribute(java.lang.String value)
java.lang.String	personEmail(MboRemote person) Gives the email address for a person.
PersonSetRemote	resolveRole(MboRemote mbo) Returns the set of PersonIDs which correspond to the role.
PersonSetRemote	resolveRole(MboRemote mbo, boolean skipemail)
PersonSetRemote	resolveRole(MboRemote mbo, boolean skipemail, boolean treatNoCalAsAvailable)
java.lang.String[]	resolveToEmail(MboRemote mbo) Returns an array of email addresses which correspond to the role.
void	setFieldFlags() Depending on the type of the role, some fields are read only.
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.

Methods inherited from class psdi.mbo.Mbo

add, addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface psdi.mbo.MboRemote

add, addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

MaxRole

public MaxRole(MboSet ms)
        throws MXException,
               java.rmi.RemoteException

Construct the MaxRole object

Throws:

MXException

java.rmi.RemoteException

Method Detail

setFieldFlags

public void setFieldFlags()
                   throws MXException,
                          java.rmi.RemoteException

Depending on the type of the role, some fields are read only.

Parameters:

type - Role type of this MaxRole.

Throws:

MXException

java.rmi.RemoteException

resolveRole

public PersonSetRemote resolveRole(MboRemote mbo)
                            throws MXException,
                                   java.rmi.RemoteException

Returns the set of PersonIDs which correspond to the role.

Specified by:

resolveRole in interface MaxRoleRemote

Parameters:

mbo - The mbo on whose behalf we are resolving the role for. Used as a starting point for DataSet.

Returns:

The set of PersonIDs

Throws:

MXApplicationException - Throw with "role", "EmailOnly" and the name of the role in the parameter list if the role can only return email addresses.

MXException

java.rmi.RemoteException

See Also:

MaxRole.resolveRole(MboRemote)

resolveRole

public PersonSetRemote resolveRole(MboRemote mbo,
                                   boolean skipemail)
                            throws MXException,
                                   java.rmi.RemoteException

Specified by:

resolveRole in interface MaxRoleRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxRole.resolveRole(MboRemote,boolean)

resolveRole

public PersonSetRemote resolveRole(MboRemote mbo,
                                   boolean skipemail,
                                   boolean treatNoCalAsAvailable)
                            throws MXException,
                                   java.rmi.RemoteException

Specified by:

resolveRole in interface MaxRoleRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxRole.resolveRole(MboRemote,boolean,boolean)

getGroupPeople

public PersonSetRemote getGroupPeople(PersonGroupRemote group,
                                      MboRemote mbo)
                               throws java.rmi.RemoteException,
                                      MXException

Return the set of Person based upon the group and the IsBroadcast flag.

Parameters:

group - The group to work from.

mbo - The mbo on whose behalf we are resolving this PersonGroup.

Returns:

The PersonSet.

Throws:

java.rmi.RemoteException

MXException

getGroupPeople

public PersonSetRemote getGroupPeople(PersonGroupRemote group,
                                      MboRemote mbo,
                                      boolean treatNoCalAsAvailable)
                               throws java.rmi.RemoteException,
                                      MXException

Throws:

java.rmi.RemoteException

MXException

getPerson

public PersonSetRemote getPerson(java.lang.String pid)
                          throws java.rmi.RemoteException,
                                 MXException

Fetches the Person Mbo for a PersonID.

Parameters:

pid - The PersonID.

Returns:

The MboSet containing just the PersonID.

Throws:

java.rmi.RemoteException

MXException

personEmail

public java.lang.String personEmail(MboRemote person)
                             throws java.rmi.RemoteException,
                                    MXException

Gives the email address for a person.

Returns:

The person's Email Address or "" if the person doesn't have an email address.

Throws:

java.rmi.RemoteException

MXException

resolveToEmail

public java.lang.String[] resolveToEmail(MboRemote mbo)
                                  throws MXException,
                                         java.rmi.RemoteException

Returns an array of email addresses which correspond to the role.

Specified by:

resolveToEmail in interface MaxRoleRemote

Parameters:

mbo - The mbo on whose behalf we are resolving the role for. Used as a starting point for DataSet.

Returns:

The array of email addresses

Throws:

MXException

java.rmi.RemoteException

See Also:

(MboRemote)

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

Description copied from class: Mbo

Can the object be deleted ? This is object specific and should be overridden.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

getType

public java.lang.String getType()
                         throws MXException,
                                java.rmi.RemoteException

Returns the role's type.

Specified by:

getType in interface MaxRoleRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

(MboRemote)

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Overrides the skipCopyField() in the Mbo. While this MaxRole MBO is being copied, this method checks if each attribute needs to be copied by using the data from the static HashSet skipFieldCopy. This method also checks whether certain attributes whose "to copy or not to copy" status is instance-specific and cannot be added to the static HashSet should be copied for this object.

Overrides:

skipCopyField in class Mbo

Parameters:

MboValueInfo - object of the MboValue that needs to be copied.

Returns:

true if the field does not need to be copied. Otherwise, false is returned.

Throws:

java.rmi.RemoteException

MXException

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

isAttribute

public boolean isAttribute(java.lang.String value)
                    throws java.rmi.RemoteException

Specified by:

isAttribute in interface MaxRoleRemote

Throws:

java.rmi.RemoteException

See Also:

(String)