Method Summary |
|
public void | addRole(CMCRolePrincipal rolePrincipal) Add a role to this community node. |
public void | addUsers(Set uids, CMCRolePrincipal rolePrincipal) Add users to this community node. |
public void | create() Create this community node persistently. |
public boolean | exists() Does this community node exist persistently?
throws: com.sun.portal.community.mc.CommunityException - If there was a problem determining if this community node exists persistently. |
public CMCPrincipal | getCMCPrincipal() Get the community principal that identifies this object. |
public String | getCategory() Returns the classification for the community
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if this setDPDocuments() operation is supported in this community. |
public long | getCommunityCreationTime() Returns the time when community was created.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem performing the operation. |
public ConfigTable | getDPDocuments() Get the Display Profile documents associated with this community node.
This method returns the DP documents for all community roles supported
by the community node. |
public ConfigTable | getDPDocuments(Set rolePrincipals) Get the Display Profile documents for this community node, for the given set of roles.
The values in the returned ConfigTable object
are byte[] objects. |
public ConfigTable | getDPDocumentsLastModified() Get the last modified times for the DP documents of this community node.
This method returns the modified times for all community roles supported
by the community node. |
public ConfigTable | getDPDocumentsLastModified(Set rolePrincipals) Get the last modified times for the DP documents of this community node for
the given set of roles.
The modified time values are in milliseconds,
the difference between the current time and midnight,
January 1, 1970 UTC. |
public String | getDescription() Returns the description for the community
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if this setDPDocuments() operation is supported in this community. |
public Set | getRoles() Get the roles for this community node. |
public Set | getUsers() Get all users of this community node. |
public Set | getUsers(Set rolePrincipals) Get the users that have the given roles for this community node.
Parameters: rolePrincipals - A Set of RolePrincipal s, the roles to match to community node users to be returned. |
public void | init(Properties properties, CMCPrincipal communityPrincipal) Initialize this CommunityNode object.
CommunityNode objects must be initialized before they are used. |
public boolean | isListed() Is this community listed in the search database ?
throws: com.sun.portal.community.mc.CommunityException - if there was a problem evaluating that. |
public boolean | isMembershipRestricted() Is the membership restricted for the community?
throws: com.sun.portal.community.mc.CommunityException - if there was a problem evaluating that. |
public boolean | isSecure() Are the community contents secured or accessible to all.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem evaluating that. |
public void | remove() Remove this community node persistently. |
public void | removeRole(CMCRolePrincipal rolePrincipal) Remove a role from this community node. |
public void | removeUsers(Set uids, Set rolePrincipals) Remove users from roles in this community node. |
public void | setCategory(String classification) |
public void | setDPDocuments(ConfigTable dpDocuments) Set DP documents for this community node. |
public void | setDescription(String description) |
public void | setListed(boolean isListed) Set the flag indicating the community is listed in the database. |
public void | setMembershipRestricted(boolean isMembershipRestricted) Set the flag indicating whether the community membership is restricting. |
public void | setSecure(boolean isSecure) Set the flag indicating whether the community content are secured. |
public boolean | supportsAddRole() |
public boolean | supportsAddUsers() |
public boolean | supportsCategory() Does this community node support the getCategory() and
setCategory() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if this setDPDocuments() operations are supported in this community. |
public boolean | supportsCommunityCreationTime() Does this community node support the getComunityCreationTime() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if operation is supported in this community. |
public boolean | supportsCreate() Does this community node support the create() operation?
throws: com.sun.portal.community.mc.CommunityException - If there was a problem testing if the create() operation is supported. |
public boolean | supportsDescription() Does this community node support the getDescription() and
setDescription() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if this setDPDocuments() operations are supported in this community. |
public boolean | supportsGetRoles() |
public boolean | supportsListing() Does this community node support the isListed() and
setListed() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if operations are supported in this community. |
public boolean | supportsMembershipRestriction() Does this community node support the isMembershipRestricted() and
setMembershipRestricted() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if operations are supported in this community. |
public boolean | supportsRemove() Does this community node support the remove() operation?
throws: com.sun.portal.community.mc.CommunityException - If there was a problem determining if the remove() operation is supported. |
public boolean | supportsRemoveRole() |
public boolean | supportsRemoveUsers() |
public boolean | supportsRole(CMCRolePrincipal rolePrincipal) Does this community node support the given role?
Parameters: rolePrincipal - A RolePrincipal to test. throws: com.sun.portal.community.mc.CommunityException - If there was a problem testing support for the role. |
public boolean | supportsRoleCreationTime() Does this community node support the getRoleCreationTime() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if this setDPDocuments() operation is supported in this community. |
public boolean | supportsSecuring() Does this community node support the isSecure() and
setSecure() operation.
throws: com.sun.portal.community.mc.CommunityException - if there was a problem determining if operations are supported in this community. |
public boolean | supportsSetDPDocuments() Does this community node support the setDPDocuments() operation?
throws: com.sun.portal.community.mc.CommunityException - If there was a problem determining if this setDPDocuments() operation is supported in this community. |