Class GroupType
java.lang.Object
com.appiancorp.suiteapi.personalization.GroupTypeBase
com.appiancorp.suiteapi.personalization.GroupType
- All Implemented Interfaces:
LocalId
,Serializable
This represents the common GroupType object. Name of group type must be unique. You must pass the correct attribute list with the correct name and type for each attribute with the GroupType when updating.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetId()
Returns this object's local identifier,null
if the object was not identified locally using aLong
Id.int
Returns 1 if the Group Type name isConstants.DEPARTMENTS_GROUP_TYPE_NAME
, 2 if the Group Type name isConstants.TEAMS_GROUP_TYPE_NAME
, 4 if the Group Type name isConstants.CUSTOM_GROUP_TYPE_NAME
, 8 if the Group Type name isConstants.GROUP_TYPE_DATABASE_SCHEMA_VIEWER_NAME
, and 16 if the Group Type name isConstants.GROUP_TYPE_DATABASE_SCHEMA_EDITOR_NAME
getUuid()
Returns the UUID of this Group Type.void
setAttributes
(Attribute[] attributes) void
setDescription
(String description) void
Sets this object's local identifier.void
setSpecial
(int special_) SeegetSpecial()
.void
Set the UUID of this Group Type.toString()
Methods inherited from class com.appiancorp.suiteapi.personalization.GroupTypeBase
getCreated, getCreator, getGroupTypeName, getLastModified, setCreated, setCreator, setGroupTypeName, setLastModified
-
Field Details
-
SORT_BY_GROUP_TYPE_NAME
-
SORT_BY_CREATED
-
SORT_BY_LAST_MODIFIED
-
SORT_BY_CREATOR
-
SORT_BY_ID
-
SORT_BY_ATTRIBUTES
-
SORT_BY_DESCRIPTION
-
-
Constructor Details
-
GroupType
public GroupType() -
GroupType
Instantiate a group type with the fields that must be populated to create the group type in the database.- Parameters:
name
- The group type name.creatorUsername
- The username of the group type creator.
-
-
Method Details
-
getId
Description copied from interface:LocalId
Returns this object's local identifier,null
if the object was not identified locally using aLong
Id. -
setId
Description copied from interface:LocalId
Sets this object's local identifier. -
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Returns the UUID of this Group Type. This field is not populated unless:- the group type is a system group type (such as Departments)
- the group type has previously been exported
- the group type was assigned a UUID when it was created
- the group type was assigned a UUID using the Import/Export API
-
setUuid
Set the UUID of this Group Type. This value is ignored, except when the Group Type is being created. -
getSpecial
public int getSpecial()Returns 1 if the Group Type name isConstants.DEPARTMENTS_GROUP_TYPE_NAME
, 2 if the Group Type name isConstants.TEAMS_GROUP_TYPE_NAME
, 4 if the Group Type name isConstants.CUSTOM_GROUP_TYPE_NAME
, 8 if the Group Type name isConstants.GROUP_TYPE_DATABASE_SCHEMA_VIEWER_NAME
, and 16 if the Group Type name isConstants.GROUP_TYPE_DATABASE_SCHEMA_EDITOR_NAME
-
setSpecial
public void setSpecial(int special_) SeegetSpecial()
. This field cannot be updated in the database. -
getDescription
-
setDescription
-
getAttributes
-
setAttributes
-
toString
- Overrides:
toString
in classGroupTypeBase
-