ome.services.graphs

Interface GraphTraversal.Processor

All Known Implementing Classes:

BaseGraphTraversalProcessor, NullGraphTraversalProcessor

Enclosing class:

GraphTraversal

public static interface GraphTraversal.Processor

Executes the planned operation.

Since:

5.1.0

Author:

m.t.b.carroll@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
void	assertMayProcess(String className, long id, Details details) Assert that an object with the given details may be processed.
void	deleteInstances(String className, Collection<Long> ids) Delete the given instances.
Set<GraphPolicy.Ability>	getRequiredPermissions()
void	nullProperties(String className, String propertyName, Collection<Long> ids) Null the given property of the indicated instances.
void	processInstances(String className, Collection<Long> ids) Process the given instances.

Method Detail

nullProperties

void nullProperties(String className,
                    String propertyName,
                    Collection<Long> ids)

Null the given property of the indicated instances.

Parameters:

className - full name of mapped Hibernate class

propertyName - HQL-style property name of class

ids - applicable instances of class, no more than GraphTraversal.BATCH_SIZE

deleteInstances

void deleteInstances(String className,
                     Collection<Long> ids)
              throws GraphException

Delete the given instances.

Parameters:

className - full name of mapped Hibernate class

ids - applicable instances of class, no more than GraphTraversal.BATCH_SIZE

Throws:

GraphException - if not all the instances could be deleted

processInstances

void processInstances(String className,
                      Collection<Long> ids)
               throws GraphException

Process the given instances. They will have been sufficiently unlinked by the other methods.

Parameters:

className - full name of mapped Hibernate class

ids - applicable instances of class, no more than GraphTraversal.BATCH_SIZE

Throws:

GraphException - if not all the instances could be processed

getRequiredPermissions

Set<GraphPolicy.Ability> getRequiredPermissions()

Returns:

the permissions required for processing instances with processInstances(String, Collection)

assertMayProcess

void assertMayProcess(String className,
                      long id,
                      Details details)
               throws GraphException

Assert that an object with the given details may be processed. Called only if the user is not an administrator.

Parameters:

className - the name of the object's class

id - the ID of the object

details - the object's details

Throws:

GraphException - if the object may not be processed