public interface GroupTypeService extends ContextSensitiveSingletonService
GroupType
can be
customized to have different Attributes
Attribute
.
The attribute types that are supported are listed below. There are five
primitive types and two Appian types -
User User
and
Group Group
GroupService
,
UserService
,
UserProfileService
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACTION_GROUPTYPE_ADD_GROUPTYPE_DYNAMIC_ATTRIBUTES
The action of add to a group type's dynamic attributes
|
static java.lang.Integer |
ACTION_GROUPTYPE_DELETE_GROUPTYPE
The action of deleting a group type
|
static java.lang.Integer |
ACTION_GROUPTYPE_DELETE_GROUPTYPE_DYNAMIC_ATTRIBUTES
The action of delete a group type's dynamic attributes
|
static java.lang.Integer |
ACTION_GROUPTYPE_EDIT_GROUPTYPE_ATTRIBUTES
The action of editing a group type
|
static java.lang.Integer |
ACTION_GROUPTYPE_EDIT_GROUPTYPE_DYNAMIC_ATTRIBUTES
The action of edit a group type's dynamic attributes
|
static java.lang.Integer |
ACTION_GROUPTYPE_MODIFY_GROUPTYPE_SECURITY_SETTINGS
The action of modifying a group type's security settings
|
static java.lang.Integer |
ACTION_GROUPTYPE_USE_GROUPTYPE
The action of using a group type (creating groups of that type)
|
static java.lang.Integer |
ACTION_GROUPTYPE_VIEW_GROUPTYPE_ATTRIBUTES
The action of viewing a group type's attributes
|
static java.lang.Integer |
ACTION_GROUPTYPE_VIEW_GROUPTYPE_EXISTENCE
The action of viewing a group type
|
static boolean |
addAttribute$UPDATES |
static boolean |
createGroupType$UPDATES |
static boolean |
deleteAttribute$UPDATES |
static boolean |
deleteGroupType$UPDATES |
static boolean |
deleteGroupTypes$UPDATES |
static boolean |
doesGroupTypeExist$UPDATES |
static boolean |
getAllGroupTypeAttributes$UPDATES |
static boolean |
getAllGroupTypeAttributesForGroupRules$UPDATES |
static boolean |
getAllGroupTypes$UPDATES |
static boolean |
getApplicationName$UPDATES |
static boolean |
getGroupType$UPDATES |
static boolean |
getGroupTypeActions$UPDATES |
static boolean |
getGroupTypeAttributes$UPDATES |
static boolean |
getGroupTypeId$UPDATES |
static boolean |
getGroupTypeIds$UPDATES |
static boolean |
getGroupTypeName$UPDATES |
static boolean |
getGroupTypeNames$UPDATES |
static boolean |
getGroupTypes$UPDATES |
static boolean |
getOperatorsForDataType$UPDATES |
static boolean |
getWorkspace$UPDATES |
static boolean |
isAttributeUnique$UPDATES |
static java.lang.Integer |
TYPE_BOOLEAN
Type for attributes that are booleans
|
static java.lang.Integer |
TYPE_DATE
Type for attributes that are dates
|
static java.lang.Integer |
TYPE_FLOAT
Type for attributes that are decimals
|
static java.lang.Integer |
TYPE_GROUP
Type for attributes that are Appian Groups
Group |
static java.lang.Integer |
TYPE_INTEGER
Type for attributes that are integers
|
static java.lang.Integer |
TYPE_STRING
Type for attributes that are strings
|
static java.lang.Integer |
TYPE_USER
Type for attributes that are Appian Users
User |
static boolean |
updateGroupType$UPDATES |
CONFIGURE_METHOD_NAME
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(java.lang.Long groupTypeId_,
Attribute attribute_)
Adds a new attribute to a group type.
|
java.lang.Long |
createGroupType(GroupType groupType_)
Creates a new group type.
|
void |
deleteAttribute(java.lang.Long groupTypeId_,
java.lang.String attributeName_)
Deletes a single attribute from a given group type
The attribute will also be deleted from groups that reference this group
type.
|
void |
deleteGroupType(java.lang.Long groupTypeId_)
Deletes a single group type.
|
void |
deleteGroupTypes(java.lang.Long[] groupTypeIds_)
Deletes a list of group types.
|
boolean |
doesGroupTypeExist(java.lang.Long groupTypeId_)
Determines whether a given group type exists
|
boolean |
doesGroupTypeExist(java.lang.String groupTypeName_)
Checks to see if a given group type exists
|
Attribute[] |
getAllGroupTypeAttributes(java.lang.Long groupTypeId_)
Gets the list of group type attributes for a particular group type,
both fixed and dynamic attributes.
|
Attribute[] |
getAllGroupTypeAttributesForGroupRules(java.lang.Long groupTypeId_)
Deprecated.
|
GroupType[] |
getAllGroupTypes()
Gets a list of all group types
|
java.lang.String |
getApplicationName()
Gets the name of the application on which this service is running.
|
GroupType |
getGroupType(java.lang.Long groupTypeId_)
Gets a group type by ID.
|
java.lang.Boolean[] |
getGroupTypeActions(java.lang.Long groupTypeId_,
java.lang.Integer[] actionIds_)
Gets Boolean array for the actions passed in, that indicates whether the
actions can be performed on the given group type by the current user.
|
Attribute[] |
getGroupTypeAttributes(java.lang.Long groupTypeId_)
Gets the list of fixed attributes for a given group type.
|
java.lang.Long |
getGroupTypeId(java.lang.String groupTypeName_)
Gets the ID for a given group type, by group type name.
|
java.lang.Long[] |
getGroupTypeIds(java.lang.String[] groupTypeNames_)
Gets a list of group type ids for a given set of group type names.
|
java.lang.String |
getGroupTypeName(java.lang.Long groupTypeId_)
Gets the name of the group type that corresponds to a given group type ID.
|
java.lang.String[] |
getGroupTypeNames(java.lang.Long[] groupTypeIds_)
Gets the names of the group types that correspond to a given list of
group type IDs.
|
GroupType[] |
getGroupTypes(java.lang.Long[] groupTypeIds_)
Gets a list of group types by ID
|
Operator[] |
getOperatorsForDataType(int dataType_)
Gets a list of possible operators for a given data type.
|
java.lang.String[] |
getWorkspace()
Gets the current memory profile for the workspace.
|
boolean |
isAttributeUnique(java.lang.String attributeName_,
java.lang.Long groupTypeId_)
Determines whether a given attribute name is unique for a particular group
type
|
void |
updateGroupType(GroupType groupType_)
Updates a group type's name and description.
|
configureContextSensitiveSingletonService
static final java.lang.Integer TYPE_BOOLEAN
static final java.lang.Integer TYPE_STRING
static final java.lang.Integer TYPE_INTEGER
static final java.lang.Integer TYPE_FLOAT
static final java.lang.Integer TYPE_DATE
static final java.lang.Integer TYPE_USER
User
static final java.lang.Integer TYPE_GROUP
Group
static final java.lang.Integer ACTION_GROUPTYPE_DELETE_GROUPTYPE
static final java.lang.Integer ACTION_GROUPTYPE_MODIFY_GROUPTYPE_SECURITY_SETTINGS
static final java.lang.Integer ACTION_GROUPTYPE_EDIT_GROUPTYPE_ATTRIBUTES
static final java.lang.Integer ACTION_GROUPTYPE_VIEW_GROUPTYPE_ATTRIBUTES
static final java.lang.Integer ACTION_GROUPTYPE_DELETE_GROUPTYPE_DYNAMIC_ATTRIBUTES
static final java.lang.Integer ACTION_GROUPTYPE_EDIT_GROUPTYPE_DYNAMIC_ATTRIBUTES
static final java.lang.Integer ACTION_GROUPTYPE_ADD_GROUPTYPE_DYNAMIC_ATTRIBUTES
static final java.lang.Integer ACTION_GROUPTYPE_USE_GROUPTYPE
static final java.lang.Integer ACTION_GROUPTYPE_VIEW_GROUPTYPE_EXISTENCE
static final boolean addAttribute$UPDATES
static final boolean createGroupType$UPDATES
static final boolean deleteAttribute$UPDATES
static final boolean deleteGroupType$UPDATES
static final boolean deleteGroupTypes$UPDATES
static final boolean getGroupTypeAttributes$UPDATES
static final boolean getGroupType$UPDATES
static final boolean getGroupTypeId$UPDATES
static final boolean getGroupTypeIds$UPDATES
static final boolean getAllGroupTypes$UPDATES
static final boolean getGroupTypes$UPDATES
static final boolean getGroupTypeName$UPDATES
static final boolean getGroupTypeNames$UPDATES
static final boolean updateGroupType$UPDATES
static final boolean getOperatorsForDataType$UPDATES
static final boolean doesGroupTypeExist$UPDATES
static final boolean getGroupTypeActions$UPDATES
static final boolean isAttributeUnique$UPDATES
static final boolean getAllGroupTypeAttributes$UPDATES
static final boolean getAllGroupTypeAttributesForGroupRules$UPDATES
static final boolean getApplicationName$UPDATES
static final boolean getWorkspace$UPDATES
void addAttribute(java.lang.Long groupTypeId_, Attribute attribute_) throws InvalidGroupTypeException, DuplicateNameException, UnsupportedAttributeTypeException, InvalidAttributeValueException
Attribute
names must be unique for a particular group type.
In order to minimize possible breaks with the user interface, it is HIGHLY
recommended that the Attribute
name be validated for illegal
characters (only allow alphanumeric symbols and underscores).
attribute_
- the Attribute
to be added. The following
fields must be populated in the Attribute
object:
name
and type
groupTypeId_
- the ID of the group type to which to add the attributeInvalidGroupTypeException
- if the no group type with the given ID
existsDuplicateNameException
- if there already exists an attribute for
the given group type with the given nameUunsupportedAttributeTypeException
- if the type of the attribute
is invalidInvalidAttributeValueException
- if the value of the attribute is
incompatible with its type. This may occur if the type of the
value
field does not match the value of the type
field, or if an invalid number or too large a number is given for attribute
type Attribute.TYPE_FLOAT
or Attribute.TYPE_INTEGER
ServiceException
- if any system-level error occursUnsupportedAttributeTypeException
java.lang.Long createGroupType(GroupType groupType_) throws DuplicateNameException, InvalidNameException, InvalidUserException, InvalidAttributeValueException, DuplicateUuidException
The name of group type must be unique among all group types.
In order to minimize possible breaks with the user interface, it is
HIGHLY recommended that the GroupType
name be validated for
illegal characters (only allow alphanumeric symbols and underscores).
groupType_
- the group type to be created.
GroupType
fields required for creation are:
groupTypeName
and creator
.DuplicateNameException
- if a group type already exists with the
given nameInvalidNameException
- if the group type name is null.InvalidUserException
- if an invalid user is passed as creator of
the group type.InvalidAttributeValueException
- if the value of a group type
attribute is incompatible with its type. This may occur if the type of the
value
field does not match the value of the type
field, or if an invalid number or too large a number is given for attribute
type Attribute.TYPE_FLOAT
or Attribute.TYPE_INTEGER
DuplicateUuidException
- if the UUID passed in already exists in the system.ServiceException
- if any system-level error occursvoid deleteAttribute(java.lang.Long groupTypeId_, java.lang.String attributeName_) throws InvalidGroupTypeException, InvalidAttributeException
groupTypeId_
- the group type IDattributeName_
- the attribute nameInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeInvalidAttributeException
- if the group type does not have an
attribute with the given nameServiceException
- if any system-level error occursvoid deleteGroupType(java.lang.Long groupTypeId_) throws InvalidGroupTypeException, GroupsExtantException
GroupService.getGroupsOfType(Long)
.groupTypeId_
- the ID of group type to deleteInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeGroupsExtantException
- if there exist groups of the given group
type or if there exist group rules that reference the given group typeServiceException
- if any system-level error occursvoid deleteGroupTypes(java.lang.Long[] groupTypeIds_) throws InvalidGroupTypeException, GroupsExtantException
GroupService.getGroupsOfType(Long)
.groupTypeIds_
- the list of IDs of group types to deleteInvalidGroupTypeException
- if any group type ID does not refer to a
valid group typeGroupsExtantException
- if there exist groups of any of the given group
types or if there exist group rules that reference any of the given group typesServiceException
- if any system-level error occursAttribute[] getGroupTypeAttributes(java.lang.Long groupTypeId_) throws InvalidGroupTypeException
name
, description
,
creator
, timestampModified
,
timestampCreated
.groupTypeId_
- the ID of the group type for which to retrieve
attributesAttribute
list; null
if the group
type has no attributesInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursGroupType getGroupType(java.lang.Long groupTypeId_) throws InvalidGroupTypeException
groupTypeId_
- the Id of the group typeInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursjava.lang.Long getGroupTypeId(java.lang.String groupTypeName_)
groupTypeName_
- the name of group typeServiceException
- if any system-level error occursjava.lang.Long[] getGroupTypeIds(java.lang.String[] groupTypeNames_)
groupTypeNames_
- the list of group type namesServiceException
- if any system-level error occursGroupType[] getAllGroupTypes()
ServiceException
- if any system-level error occursGroupType[] getGroupTypes(java.lang.Long[] groupTypeIds_) throws InvalidGroupTypeException
groupTypeIds_
- a list of group type IDsInvalidGroupTypeException
- if any group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursjava.lang.String getGroupTypeName(java.lang.Long groupTypeId_) throws InvalidGroupTypeException
groupTypeId_
- the group type idInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursjava.lang.String[] getGroupTypeNames(java.lang.Long[] groupTypeIds_) throws InvalidGroupTypeException
groupTypeIds_
- the group type idsInvalidGroupTypeException
- if any group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursvoid updateGroupType(GroupType groupType_) throws InvalidGroupTypeException, DuplicateNameException
addAttribute(java.lang.Long, com.appiancorp.suiteapi.personalization.Attribute)
and deleteAttribute(java.lang.Long, java.lang.String)
In order to minimize possible breaks with the user interface, it is HIGHLY recommended that the group type name be validated for illegal characters (only allow alphanumeric symbols and underscores).
groupType_
- The group type to be updatedInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeDuplicateNameException
- if a group type with the given name already
existsServiceException
- if any system-level error occursOperator[] getOperatorsForDataType(int dataType_) throws UnsupportedAttributeTypeException
dataType_
- one of the TYPE_XXX
constantsUnsupportedAttributeTypeException
- if the data type is invalidServiceException
- if any system-level error occursboolean doesGroupTypeExist(java.lang.Long groupTypeId_)
groupTypeId_
- the ID of group typetrue
if the group type exists, false
otherwise.ServiceException
- if any system-level error occursboolean doesGroupTypeExist(java.lang.String groupTypeName_)
groupTypeName_
- the name of group typetrue
if group type exists, false
otherwiseServiceException
- if any system-level error occursjava.lang.Boolean[] getGroupTypeActions(java.lang.Long groupTypeId_, java.lang.Integer[] actionIds_) throws InvalidGroupTypeException
Boolean.TRUE
indicates that
the current user can perform the action.groupTypeId_
- the group type ID.actionIds_
- IDs of actions to check. Each ID must be one of the
ACTION_GROUPTYPE_XXX
constantsInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursboolean isAttributeUnique(java.lang.String attributeName_, java.lang.Long groupTypeId_) throws InvalidGroupTypeException
attributeName_
- the name of attributegroupTypeId_
- the ID of the group typetrue
if the group type does not already have an
attribute with the given name; false
otherwiseInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursAttribute[] getAllGroupTypeAttributes(java.lang.Long groupTypeId_) throws InvalidGroupTypeException
name
, description
,
creator
, timestampModified
,
timestampCreated
.
Dynamic attributes are those that specific to the group type. For example,
a user can add an attribute of TYPE_USER
after the group
type is created, and that will be returned in this call, but not ingroupTypeId_
- ID of the group typeInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occurs@Deprecated Attribute[] getAllGroupTypeAttributesForGroupRules(java.lang.Long groupTypeId_) throws InvalidGroupTypeException
name
, description
,
creator
, timestampModified
,
timestampCreated
.
Dynamic attributes are those that specific to the group type. For example,
a user can add an attribute of TYPE_USER
after the group
type is created, and that will be returned in this call, but not ingroupTypeId_
- ID of the group typeInvalidGroupTypeException
- if the group type ID does not refer to a
valid group typeServiceException
- if any system-level error occursjava.lang.String getApplicationName()
ServiceException
- if any system-level error occursjava.lang.String[] getWorkspace()
ServiceException
- if any system-level error occursCopyright © 2003-2024 Appian Corporation. All Rights Reserved.