public interface IDfAliasSet extends IDfPersistentObject
Modifier and Type | Field and Description |
---|---|
static int |
CATETORY_ACL_NAME
Represents the alias category when the alias value is an ACL name.
|
static int |
CATETORY_CABINET_PATH
Represents the alias category when the alias value is a cabinet path.
|
static int |
CATETORY_FOLDER_PATH
Represents the alias category when the alias value is a folder path.
|
static int |
CATETORY_GROUP
Represents the alias category when the alias value is a group.
|
static int |
CATETORY_UNKNOWN
Represents the alias category when the alias value is unknown.
|
static int |
CATETORY_USER
Represents the alias category when the alias value is a user.
|
static int |
CATETORY_USER_OR_GROUP
Represents the alias category when the alias value is either a user or a group.
|
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
int |
appendAlias(java.lang.String name,
java.lang.String value,
int category,
int userCategory,
java.lang.String description)
Appends an alias to the alias set.
|
int |
findAliasIndex(java.lang.String name)
Returns the index position of an alias in the alias set.
|
int |
getAliasCategory(int index)
Returns the category of the alias in the specified index position
in this alias set.
|
int |
getAliasCount()
Returns the number of aliases in the alias set.
|
java.lang.String |
getAliasDescription(int index)
Returns the description of the alias at the
specified index position in this alias set.
|
java.lang.String |
getAliasName(int index)
Returns the alias name at the specified index in the list of
aliases for the alias set scope.
|
int |
getAliasUserCategory(int index)
Returns the user category of the alias at the specified index
position in the alias set.
|
java.lang.String |
getAliasValue(int index)
Returns the value corresponding to the alias at the specified index
in this alias set.
|
java.lang.String |
getObjectDescription()
Returns the description of the alias set.
|
java.lang.String |
getObjectName()
Returns the name of this alias set.
|
java.lang.String |
getOwnerName()
Returns the user name of the owner of this alias set.
|
void |
removeAlias(java.lang.String name)
Removes an alias from the alias set.
|
void |
removeAllAliases()
Removes all the aliases in the alias set.
|
void |
setAliasCategory(int index,
int aliasCategory)
Sets the category for the alias in the specified index position
in the alias set.
|
void |
setAliasDescription(int index,
java.lang.String aliasDescription)
Sets the description of the alias at the
specified index position in this alias set.
|
void |
setAliasName(int index,
java.lang.String aliasName)
Sets the alias name at the specified index in this alias set.
|
void |
setAliasUserCategory(int index,
int aliasUserCategory)
Sets the user category of the alias at the specified index
position in the alias set.
|
void |
setAliasValue(int index,
java.lang.String aliasValue)
Sets the value corresponding to the alias at the specified index
in this alias set.
|
void |
setObjectDescription(java.lang.String objectDescription)
Sets the description of the alias set.
|
void |
setObjectName(java.lang.String objectName)
Sets the name of the alias set.
|
void |
setOwnerName(java.lang.String ownerName)
Sets the owner name of this alias set.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final int CATETORY_UNKNOWN
static final int CATETORY_USER
static final int CATETORY_GROUP
static final int CATETORY_USER_OR_GROUP
static final int CATETORY_CABINET_PATH
static final int CATETORY_FOLDER_PATH
static final int CATETORY_ACL_NAME
java.lang.String getOwnerName() throws DfException
DfException
- if server error occurs.setOwnerName(java.lang.String)
void setOwnerName(java.lang.String ownerName) throws DfException
ownerName
- name of the owner.DfException
- if server error occurs.getOwnerName()
java.lang.String getObjectName() throws DfException
DfException
- if server error occurs.setObjectName(java.lang.String)
void setObjectName(java.lang.String objectName) throws DfException
objectName
- the name of the alias set.DfException
- if server error occurs.getObjectName()
java.lang.String getObjectDescription() throws DfException
DfException
- if server error occurs.setObjectDescription(java.lang.String)
void setObjectDescription(java.lang.String objectDescription) throws DfException
objectDescription
- the description of the alias set.DfException
- if server error occurs.getObjectDescription()
int getAliasCount() throws DfException
DfException
- if server error occurs.java.lang.String getAliasName(int index) throws DfException
index
- the index position in this alias set.DfException
- if server error occurs.getAliasCount()
,
setAliasName(int, java.lang.String)
void setAliasName(int index, java.lang.String aliasName) throws DfException
index
- the index position in this alias set.aliasName
- the alias name.DfException
- if server error occurs.getAliasCount()
,
getAliasName(int)
java.lang.String getAliasValue(int index) throws DfException
index
- the index position in this alias set.DfException
- if server error occurs.getAliasCount()
,
setAliasValue(int, java.lang.String)
void setAliasValue(int index, java.lang.String aliasValue) throws DfException
index
- the index position in this alias set.aliasValue
- the value to set for the aliasDfException
- if server error occurs.getAliasCount()
,
getAliasValue(int)
int getAliasCategory(int index) throws DfException
index
- the index position in this alias set.DfException
- if server error occurs.getAliasCount()
,
setAliasCategory(int, int)
void setAliasCategory(int index, int aliasCategory) throws DfException
- 0 (Unknown) - 1 (User, alias_value is a user) - 2 (Group, alias_value is a group) - 3 (User or Group, alias_value is either a user or a group) - 4 (Cabinet Path, alias_value is a cabinet path) - 5 (Folder Path, alias_value is a folder path) - 6 (ACL Name, alias_value is an ACL name)
index
- the index position in this alias set.aliasCategory
- the alias category.DfException
- if server error occurs.getAliasCount()
,
getAliasCategory(int)
int getAliasUserCategory(int index) throws DfException
index
- the index position in this alias set.DfException
- if server error occurs.getAliasCount()
,
setAliasUserCategory(int, int)
void setAliasUserCategory(int index, int aliasUserCategory) throws DfException
index
- aliasUserCategory
- user alias category in the list.DfException
- if server error occurs.getAliasCount()
,
getAliasUserCategory(int)
java.lang.String getAliasDescription(int index) throws DfException
index
- the index position in this alias set.DfException
- if server error occurs.getAliasCount()
,
setAliasDescription(int, java.lang.String)
void setAliasDescription(int index, java.lang.String aliasDescription) throws DfException
index
- the index position in this alias set.aliasDescription
- the alias description.DfException
- if server error occurs.getAliasCount()
,
getAliasDescription(int)
int appendAlias(java.lang.String name, java.lang.String value, int category, int userCategory, java.lang.String description) throws DfException
name
- the name of the alias.value
- the value of the alias.category
- the integer valued category of the alias.userCategory
- the integer valued user category that the user chooses
to further categorize the alias value.description
- the description of the alias.DfException
- if the server error occurs or the alias name
already exists.setAliasCategory(int, int)
,
removeAlias(java.lang.String)
void removeAlias(java.lang.String name) throws DfException
name
- the name of the alias to be removed.DfException
- if the server error occurs.getAliasCount()
,
appendAlias(java.lang.String, java.lang.String, int, int, java.lang.String)
int findAliasIndex(java.lang.String name) throws DfException
name
- the name of the alias.DfException
- if the server error occurs.void removeAllAliases() throws DfException
DfException
- if the server error occurs.Copyright 1994-2023 OpenText Corporation. All rights reserved.