Package com.thingworx.security.groups

Class Group

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.security.groups.Group

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class Group
extends ServiceProviderEntity

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
Group()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
void	addGroupMember(EntityReference member)
void	AddMember(String member, String type)	Service Category: Members Service Description: Add a user/group to this group.
void	AssignMembers(InfoTable members)	Service Category: Members Service Description: Assign a list of users/groups to this group.
void	deleteAllGroupMembers()
void	deleteGroupMember(EntityReference member)
void	deleteGroupMember(EntityReference member, ContextType contextType)
void	DeleteMember(String member, String type)	Service Category: Members Service Description: Remove a user/group from this group.
InfoTable	FindGroupMember(org.json.JSONObject types, String name)	Service Category: Service Description: Find member by exact name in this group.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()	Returns the type of this entity.
InfoTable	GetGroupMember(String name)	Service Category: Service Description: Get members by name in this group.
InfoTable	GetGroupMembers()	Service Category: Members Service Description: Get a list of members in this group.
EntityReferenceCollection	getGroups()
InfoTable	GetGroups()	Service Category: Members Service Description: Get list of groups that this group is a member of.
EntityReferenceTypeMap	getMembers()
InfoTable	GetOrganizationalUnits()	Service Category: Members Service Description: Get list of organizational units that this group is a member of.
InfoTable	GetOrganizations()	Service Category: Members Service Description: Get list of organizations that this group is a member of.
InfoTable	QueryGroupMembers(org.json.JSONObject types, String filter, Double maxItems)	Service Category: Members Service Description: Query a list of members in this group.
void	SetHomeMashup(String name)	Service Category: Mashups Service Description: Calling SetHomeMashup on Groups is not supported.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

Group

public Group()

Initializes this instace with default values.

Method Details

getMembers

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceTypeMap getMembers()

AssignMembers

@ThingworxExtensionApiMethod(since={6,6})
public void AssignMembers(InfoTable members)
                   throws Exception

Service Category:

Members

Service Description:

Assign a list of users/groups to this group.

Parameters:

members - Members - INFOTABLE

Throws:

Exception - if an error occurs

AddMember

@ThingworxExtensionApiMethod(since={6,6})
public void AddMember(String member,
 String type)
               throws Exception

Service Category:

Members

Service Description:

Add a user/group to this group.

Parameters:

member - Member - STRING

type - Member type - STRING

Throws:

Exception - if an error occurs

DeleteMember

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteMember(String member,
 String type)
                  throws Exception

Service Category:

Members

Service Description:

Remove a user/group from this group.

Parameters:

member - Member - STRING

type - Member type - STRING

Throws:

Exception - if an error occurs

addGroupMember

@ThingworxExtensionApiMethod(since={6,6})
public void addGroupMember(EntityReference member)
                    throws Exception

Throws:

Exception

deleteGroupMember

@ThingworxExtensionApiMethod(since={6,6})
public void deleteGroupMember(EntityReference member)
                       throws Exception

Throws:

Exception

deleteGroupMember

@ThingworxExtensionApiMethod(since={9,0})
public void deleteGroupMember(EntityReference member,
 ContextType contextType)
                       throws Exception

Throws:

Exception

deleteAllGroupMembers

@ThingworxExtensionApiMethod(since={7,4})
public void deleteAllGroupMembers()
                           throws Exception

Throws:

Exception

getGroups

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceCollection getGroups()

GetGroupMembers

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroupMembers()
                          throws Exception

Service Category:

Members

Service Description:

Get a list of members in this group.

Returns:

result Group Members - INFOTABLE - Aspects {dataShape:GroupMember}

Throws:

Exception - if an error occurs

GetGroupMember

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroupMember(String name)
                         throws Exception

Service Category:

Service Description:

Get members by name in this group.

Parameters:

name - Field name - STRING

Returns:

result Group Member - INFOTABLE - Aspects {dataShape:GroupMember}

Throws:

Exception - if an error occurs

FindGroupMember

@ThingworxExtensionApiMethod(since={10,1})
public InfoTable FindGroupMember(org.json.JSONObject types,
 String name)
                          throws Exception

Service Category:

Service Description:

Find member by exact name in this group.

Parameters:

types - Entity types - JSON

name - Field name - STRING

Returns:

result Group Member - INFOTABLE - Aspects {dataShape:GroupMember}

Throws:

Exception - if an error occurs

QueryGroupMembers

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryGroupMembers(org.json.JSONObject types,
 String filter,
 Double maxItems)
                            throws Exception

Service Category:

Members

Service Description:

Query a list of members in this group.

Parameters:

types - Entity types - JSON

filter - Term filter - STRING

maxItems - Maximum number of items to return - NUMBER

Returns:

result Group Members - INFOTABLE - Aspects {dataShape:GroupMember}

Throws:

Exception - if an error occurs

GetGroups

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroups()
                    throws Exception

Service Category:

Members

Service Description:

Get list of groups that this group is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

GetOrganizationalUnits

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizationalUnits()
                                 throws Exception

Service Category:

Members

Service Description:

Get list of organizational units that this group is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

GetOrganizations

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizations()
                           throws Exception

Service Category:

Members

Service Description:

Get list of organizations that this group is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type

SetHomeMashup

@ThingworxExtensionApiMethod(since={6,6})
public void SetHomeMashup(String name)
                   throws Exception

Service Category:

Mashups

Service Description:

Calling SetHomeMashup on Groups is not supported.

Overrides:

SetHomeMashup in class RootEntity

Parameters:

name - Home mashup name - MASHUPNAME

Throws:

Exception - if an error occurs