*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface GroupInterface

All Superinterfaces:

MetadataInterface,

All Known Implementing Classes:

OMRGroup, LdapGroup

public interface GroupInterface

extends MetadataInterface

This is a generic interface for objects coming out of the repositories that represent groups. A generic group can be a collection of any type of metadata object.

Since:

1.0

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addMember(MetadataInterface member) Add a new member to the group.
void	addMemberOrdered(MetadataInterface member) Add a new member to the group such that it will be ordered even if it's in another repository (This is primarily for OMR groups).
void	addOwner(PersonInterface owner) Add a person as an owner of the group.
String	getDescription() Gets the description of the group.
List	getMembers() Get the members of the group.
List	getMembersAllRepositories() Get all the members of the group, including those that may be in dependent repositories.
List	getOwners() Get the list of owners for this list.
List	members() Get the members of the group.
boolean	removeMember(MetadataInterface member) Remove a member from the group.
void	removeOwner(PersonInterface owner) Remove a person from the owner list.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

getDescription

public String getDescription()
                      throws RemoteException

Gets the description of the group.

Specified by:

getDescription in interface MetadataInterface

Returns:

A String describing the group.

Throws:

RemoteException - in the event of remote object failure.

members

public List members()
             throws RemoteException

Get the members of the group.

Returns:

a List of MetadataInterface objects representing the members of the group.

Throws:

RemoteException - in the event of remote object failure.

getMembers

public List getMembers()
                throws RemoteException

Get the members of the group.

Returns:

a List of MetadataInterface objects representing the members of the group.

Throws:

RemoteException - in the event of remote object failure.

getMembersAllRepositories

public List getMembersAllRepositories()
                               throws ServiceException,
                                      RemoteException

Get all the members of the group, including those that may be in dependent repositories.

Returns:

A List of MetadataInterface objects representing the members of the group.

Throws:

ServiceException - In the event of repository errors.

RemoteException - In the event of remote object failure.

addMember

public void addMember(MetadataInterface member)
               throws RemoteException

Add a new member to the group.

Parameters:

member - The new member to add.

Throws:

RemoteException - in the event of remote object failure.

addMemberOrdered

public void addMemberOrdered(MetadataInterface member)
                      throws RemoteException

Add a new member to the group such that it will be ordered even if it's in another repository (This is primarily for OMR groups).

Parameters:

member - The new member to add.

Throws:

RemoteException - In the event of remote object failure.

removeMember

public boolean removeMember(MetadataInterface member)
                     throws RemoteException

Remove a member from the group.

Parameters:

member - The member to remove.

Returns:

true if the member was removed, false otherwise.

Throws:

RemoteException - in the event of remote object failure.

getOwners

public List getOwners()
               throws RemoteException

Get the list of owners for this list.

Returns:

a List of com.sas.services.information.metadata.Person objects representing the owner(s) of the group.

Throws:

RemoteException - in the event of remote object failure.

addOwner

public void addOwner(PersonInterface owner)
              throws RemoteException

Add a person as an owner of the group.

Parameters:

owner - The person to add as an owner.

Throws:

RemoteException - in the event of remote object failure.

removeOwner

public void removeOwner(PersonInterface owner)
                 throws RemoteException

Remove a person from the owner list.

Parameters:

owner - The person to remove from the list of owners.

Throws:

RemoteException - in the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***