org.osid.control

Interface ActionGroupSystemSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ActionGroupSystemSession
extends OsidSession

This session provides methods to retrieve ActionGroup to System mappings. An ActionGroup may appear in multiple System objects. Each system may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupActionGroupSystemMappings() Tests if this user can perform lookups of action group/system mappings.
IdList	getActionGroupIdsBySystem(Id systemId) Gets the list of ActionGroup Ids associated with a System.
IdList	getActionGroupIdsBySystems(IdList systemIds) Gets the list of ActionGroup Ids corresponding to a list of Systems.
ActionGroupList	getActionGroupsBySystem(Id systemId) Gets the list of ActionGroups associated with a System.
ActionGroupList	getActionGroupsBySystems(IdList systemIds) Gets the list of ActionGroup corresponding to a list of Systems.
IdList	getSystemIdsByActionGroup(Id actionGroupId) Gets the System Ids mapped to an ActionGroup.
SystemList	getSystemsByActionGroup(Id actionGroupId) Gets the Systems mapped to an ActionGroup.
void	useComparativeActionGroupSystemView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryActionGroupSystemView() A complete view of the ActionGroup and System returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupActionGroupSystemMappings

boolean canLookupActionGroupSystemMappings()

Tests if this user can perform lookups of action group/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActionGroupSystemView

void useComparativeActionGroupSystemView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryActionGroupSystemView

void usePlenaryActionGroupSystemView()

A complete view of the ActionGroup and System returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getActionGroupIdsBySystem

IdList getActionGroupIdsBySystem(Id systemId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of ActionGroup Ids associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related action group Ids

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionGroupsBySystem

ActionGroupList getActionGroupsBySystem(Id systemId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the list of ActionGroups associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related action groups

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionGroupIdsBySystems

IdList getActionGroupIdsBySystems(IdList systemIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets the list of ActionGroup Ids corresponding to a list of Systems.

Parameters:

systemIds - list of system Ids

Returns:

list of action group Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionGroupsBySystems

ActionGroupList getActionGroupsBySystems(IdList systemIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the list of ActionGroup corresponding to a list of Systems.

Parameters:

systemIds - list of system Ids

Returns:

list of action groups

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByActionGroup

IdList getSystemIdsByActionGroup(Id actionGroupId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the System Ids mapped to an ActionGroup.

Parameters:

actionGroupId - Id of an ActionGroup

Returns:

list of systems

Throws:

NotFoundException - actionGroupId is not found

NullArgumentException - actionGroupId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByActionGroup

SystemList getSystemsByActionGroup(Id actionGroupId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the Systems mapped to an ActionGroup.

Parameters:

actionGroupId - Id of an ActionGroup

Returns:

list of systems

Throws:

NotFoundException - actionGroupId is not found

NullArgumentException - actionGroupId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.