public class MaxRole extends Mbo implements MaxRoleRemote
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. |
MULTILANGCOPY, phantomList, phantomQueue
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 and Description |
---|
MaxRole(MboSet ms)
Construct the MaxRole object
|
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 |
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) |
PersonSetRemote |
resolveRole(MboRemote mbo,
boolean skipemail)
Returns the set of PersonIDs which correspond to the role.
|
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.
|
add, addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, 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, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, 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, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes
public MaxRole(MboSet ms) throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
public void setFieldFlags() throws MXException, java.rmi.RemoteException
type
- Role type of this MaxRole.MXException
java.rmi.RemoteException
public PersonSetRemote resolveRole(MboRemote mbo) throws MXException, java.rmi.RemoteException
resolveRole
in interface MaxRoleRemote
MXException
java.rmi.RemoteException
resolveRole(MboRemote)
public PersonSetRemote resolveRole(MboRemote mbo, boolean skipemail) throws MXException, java.rmi.RemoteException
mbo
- The mbo on whose behalf we are resolving the role for. Used as a starting
point for DataSet.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
public PersonSetRemote getGroupPeople(PersonGroupRemote group, MboRemote mbo) throws java.rmi.RemoteException, MXException
group
- The group to work from.mbo
- The mbo on whose behalf we are resolving this PersonGroup.java.rmi.RemoteException
MXException
public PersonSetRemote getPerson(java.lang.String pid) throws java.rmi.RemoteException, MXException
pid
- The PersonID.java.rmi.RemoteException
MXException
public java.lang.String personEmail(MboRemote person) throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public java.lang.String[] resolveToEmail(MboRemote mbo) throws MXException, java.rmi.RemoteException
resolveToEmail
in interface MaxRoleRemote
mbo
- The mbo on whose behalf we are resolving the role for. Used as a starting
point for DataSet.MXException
java.rmi.RemoteException
(MboRemote)
public void canDelete() throws MXException, java.rmi.RemoteException
Mbo
canDelete
in class Mbo
MXException
java.rmi.RemoteException
public java.lang.String getType() throws MXException, java.rmi.RemoteException
getType
in interface MaxRoleRemote
MXException
java.rmi.RemoteException
(MboRemote)
public void init() throws MXException
Mbo
init
in class Mbo
MXException
public MboRemote duplicate() throws MXException, java.rmi.RemoteException
Mbo
duplicate
in interface MboRemote
duplicate
in class Mbo
MXException
java.rmi.RemoteException
public boolean isAttribute(java.lang.String value) throws java.rmi.RemoteException
isAttribute
in interface MaxRoleRemote
java.rmi.RemoteException
(String)