Interface PathAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PathAdminSession
extends OsidSession

This session creates, updates, and deletes Paths . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Path , a PathForm is requested using gePathFormForCreate() specifying desired record Types or none if no record Types are needed. The returned PathForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the PathForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PathForm corresponds to an attempted transaction.

For updates, PathForms are requested to the Path Id that is to be updated using getPathFormForUpdate() . Similarly, the PathForm has metadata about the data that can be updated and it can perform validation before submitting the update. The PathForm can only be used once for a successful update and cannot be reused.

The delete operations delete Paths . To unmap a Path from the current Graph , the PathGraphAssignmentSession should be used. These delete operations attempt to remove the Path itself thus removing it from all known Graph catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	addEdge(Id pathId, Id edgeId)	Adds an edge to a path.
void	addEdges(Id pathId, IdList edgeIds)	Adds edges to a path.
void	aliasPath(Id pathId, Id aliasId)	Adds an Id to a Path for the purpose of creating compatibility.
boolean	canCreatePaths()	Tests if this user can create Paths .
boolean	canCreatePathWithRecordTypes(Type[] pathRecordTypes)	Tests if this user can create a single Path using the desired record types.
boolean	canDeletePaths()	Tests if this user can delete Paths .
boolean	canManagePathAliases()	Tests if this user can manage Id aliases for Paths .
boolean	canUpdatePaths()	Tests if this user can update Paths .
Path	createPath(PathForm pathForm)	Creates a new Path .
void	deletePath(Id pathId)	Deletes a Path .
Graph	getGraph()	Gets the Graph associated with this session.
Id	getGraphId()	Gets the Graph Id associated with this session.
PathForm	getPathFormForCreate(Id startingNodeId, Id endingNodeId, Type[] pathRecordTypes)	Gets the path form for creating new paths.
PathForm	getPathFormForUpdate(Id pathId)	Gets the path form for updating an existing path.
void	removeEdge(Id pathId, Id edgeId)	Removes an edge from a path.
void	removeEdges(Id pathId, IdList edgeIds)	Removes edges from a path.
void	updatePath(PathForm pathForm)	Updates an existing path.

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

getGraphId

Id getGraphId()

Gets the Graph Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
        throws OperationFailedException,
PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreatePaths

boolean canCreatePaths()

Tests if this user can create Paths . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Path will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Path ceration is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreatePathWithRecordTypes

boolean canCreatePathWithRecordTypes(Type[] pathRecordTypes)

Tests if this user can create a single Path using the desired record types. While TopologyManager.getPathRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Path . Providing an empty array tests if a Path can be created with no records.

Parameters:

pathRecordTypes - array of path record types

Returns:

true if Path creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - pathRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getPathFormForCreate

PathForm getPathFormForCreate(Id startingNodeId,
 Id endingNodeId,
 Type[] pathRecordTypes)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the path form for creating new paths. A new form should be requested for each create transaction.

Parameters:

startingNodeId - the Id of the starting location

endingNodeId - the Id of the ending location

pathRecordTypes - array of path record types

Returns:

the path form

Throws:

NotFoundException - startingLocationId or endingLocationId is not found

NullArgumentException - startingLocationId, endingLocationId , or pathRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createPath

Path createPath(PathForm pathForm)
         throws OperationFailedException,
PermissionDeniedException

Creates a new Path .

Parameters:

pathForm - the form for this Path

Returns:

the new Path

Throws:

IllegalStateException - pathForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - pathForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pathForm did not originate from getPathFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdatePaths

boolean canUpdatePaths()

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

Returns:

false if Path modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPathFormForUpdate

PathForm getPathFormForUpdate(Id pathId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the path form for updating an existing path. A new path form should be requested for each update transaction.

Parameters:

pathId - the Id of the Path

Returns:

the path form

Throws:

NotFoundException - pathId is not found

NullArgumentException - pathId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePath

void updatePath(PathForm pathForm)
         throws OperationFailedException,
PermissionDeniedException

Updates an existing path.

Parameters:

pathForm - the form containing the elements to be updated

Throws:

IllegalStateException - pathForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - pathForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pathForm did not originate from getPathFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeletePaths

boolean canDeletePaths()

Tests if this user can delete Paths . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Path will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Path deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deletePath

void deletePath(Id pathId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Path .

Parameters:

pathId - the Id of the Path to remove

Throws:

NotFoundException - pathId not found

NullArgumentException - pathId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addEdge

void addEdge(Id pathId,
 Id edgeId)
      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an edge to a path.

Parameters:

pathId - the Id of a Path

edgeId - the Id of the Edge to add

Throws:

AlreadyExistsException - edgeId already in path

NotFoundException - pathId or edgeId not found

NullArgumentException - pathId or edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addEdges

void addEdges(Id pathId,
 IdList edgeIds)
       throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds edges to a path.

Parameters:

pathId - the Id of Path

edgeIds - the Ids of the Edges to add

Throws:

AlreadyExistsException - edgeId already in path

NotFoundException - pathId or an edgeId not found

NullArgumentException - pathId or edgeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeEdge

void removeEdge(Id pathId,
 Id edgeId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an edge from a path.

Parameters:

pathId - the Id of a Path

edgeId - the Id of the Edge to add

Throws:

NotFoundException - pathId does not contain edgeId

NullArgumentException - pathId or edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeEdges

void removeEdges(Id pathId,
 IdList edgeIds)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes edges from a path.

Parameters:

pathId - the Id of a Path

edgeIds - the list of Ids of the Edges to add

Throws:

NotFoundException - pathId does not contain an edgeId

NullArgumentException - pathId or edgeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManagePathAliases

boolean canManagePathAliases()

Tests if this user can manage Id aliases for Paths . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Path aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasPath

void aliasPath(Id pathId,
 Id aliasId)
        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Path for the purpose of creating compatibility. The primary Id of the Path is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another path, it is reassigned to the given node Id .

Parameters:

pathId - the Id of a Path

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - pathId not found

NullArgumentException - pathId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.