Interface StoreHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StoreHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of stores. Stores may be organized into a hierarchy for organizing or federating. A parent Store includes all of the orders of its children such that a single root node contains all of the orders of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildStore(Id storeId, Id childId)	Adds a child to a store.
void	addRootStore(Id storeId)	Adds a root store.
boolean	canModifyStoreHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getStoreHierarchy()	Gets the hierarchy associated with this session.
Id	getStoreHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildStore(Id storeId, Id childId)	Removes a child from a store.
void	removeChildStores(Id storeId)	Removes all children from a store.
void	removeRootStore(Id storeId)	Removes a root store.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getStoreHierarchyId

Id getStoreHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getStoreHierarchy

Hierarchy getStoreHierarchy()
                     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.

canModifyStoreHierarchy

boolean canModifyStoreHierarchy()

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.

addRootStore

void addRootStore(Id storeId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root store.

Parameters:

storeId - the Id of a store

Throws:

AlreadyExistsException - storeId is already in hierarchy

NotFoundException - storeId is not found

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootStore

void removeRootStore(Id storeId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root store.

Parameters:

storeId - the Id of a store

Throws:

NotFoundException - storeId is not a root

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildStore

void addChildStore(Id storeId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a store.

Parameters:

storeId - the Id of a store

childId - the Id of the new child

Throws:

AlreadyExistsException - storeId is already a parent of childId

NotFoundException - storeId or childId not found

NullArgumentException - storeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildStore

void removeChildStore(Id storeId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a store.

Parameters:

storeId - the Id of a store

childId - the Id of the new child

Throws:

NotFoundException - storeId not a parent of childId

NullArgumentException - storeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildStores

void removeChildStores(Id storeId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a store.

Parameters:

storeId - the Id of a store

Throws:

NotFoundException - storeId not found

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.