org.osid.resourcing

Interface FoundryHierarchyDesignSession

All Superinterfaces:

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

public interface FoundryHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Foundry objects. Each node in the hierarchy is a unique Foundry.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildFoundry(Id foundryId, Id childId) Adds a child to a foundry.
void	addRootFoundry(Id foundryId) Adds a root foundry.
boolean	canModifyFoundryHierarchy() Tests if this user can change the hierarchy.
Hierarchy	getFoundryHierarchy() Gets the hierarchy associated with this session.
Id	getFoundryHierarchyId() Gets the hierarchy Id associated with this session.
void	removeChildFoundries(Id foundryId) Removes all children from a foundry.
void	removeChildFoundry(Id foundryId, Id childId) Removes a child from a foundry.
void	removeRootFoundry(Id foundryId) Removes a root foundry.

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

getFoundryHierarchyId

Id getFoundryHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundryHierarchy

Hierarchy getFoundryHierarchy()
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyFoundryHierarchy

boolean canModifyFoundryHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootFoundry

void addRootFoundry(Id foundryId)
                    throws AlreadyExistsException,
                           NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Adds a root foundry.

Parameters:

foundryId - the Id of a foundry

Throws:

AlreadyExistsException - foundryId is already in hierarchy

NotFoundException - foundryId not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootFoundry

void removeRootFoundry(Id foundryId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Removes a root foundry.

Parameters:

foundryId - the Id of a foundry

Throws:

NotFoundException - foundryId is not a root

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildFoundry

void addChildFoundry(Id foundryId,
                   Id childId)
                     throws AlreadyExistsException,
                            NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Adds a child to a foundry.

Parameters:

foundryId - the Id of a foundry

childId - the Id of the new child

Throws:

AlreadyExistsException - foundryId is already a parent of childId

NotFoundException - foundryId or childId not found

NullArgumentException - foundryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFoundry

void removeChildFoundry(Id foundryId,
                      Id childId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Removes a child from a foundry.

Parameters:

foundryId - the Id of a foundry

childId - the Id of the new child

Throws:

NotFoundException - foundryId is not parent of childId

NullArgumentException - foundryId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFoundries

void removeChildFoundries(Id foundryId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Removes all children from a foundry.

Parameters:

foundryId - the Id of a foundry

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.