|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RegistryService
Method Summary | |
---|---|
void |
changeObjectStatus(String user,
String guid,
ObjectAction action,
Class<? extends RegistryObject> objectClass)
Changes the status of registry object with the given guid and of the given type |
void |
changeObjectStatus(String user,
String lid,
String versionId,
ObjectAction action,
Class<? extends RegistryObject> objectClass)
Changes the RegistryObject status with the given identifying
information. |
String |
configure(String user,
RegistryPackage registryPackage,
List<? extends RegistryObject> list)
Configures the registry with a list of registry objects as input. |
void |
deleteObject(String user,
String guid,
Class<? extends RegistryObject> objectClass)
Deletes a RegistryObject from the registry which share the logical
identifier and version. |
void |
deleteObject(String user,
String lid,
String versionId,
Class<? extends RegistryObject> objectClass)
Deletes a RegistryObject from the registry which share the logical
identifier and version. |
Association |
getAssocation(String guid)
Retrieves the Association from the registry with the given guid |
RegistryResponse |
getAssociations(AssociationQuery query,
Integer start,
Integer rows)
Retrieves a set of associations that match the given query. |
RegistryResponse |
getAuditableEvents(String affectedObject)
Retrieves the list of (@link AuditableEvent}'s for the affected object |
List<ClassificationNode> |
getClassificationNodes(String scheme)
Retrieves all ClassificationNode for a given
ClassificationScheme |
RegistryObject |
getEarliestObject(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves the earliest version of the RegsitryObject with the given
logical identifier |
ExtrinsicObject |
getExtrinsic(String guid)
Retrieves a ExtrinsicObject from the registry |
RegistryResponse |
getExtrinsics(ExtrinsicQuery query)
Retrieves the first set of extrinsics that match the query |
RegistryResponse |
getExtrinsics(ExtrinsicQuery query,
Integer start,
Integer rows)
Retrieves a set of extinsics that match the given query. |
RegistryResponse |
getExtrinsics(Integer start,
Integer rows)
This method allows one to page through the ExtrinsicObject 's in the
registry. |
IdentifierGenerator |
getIdentifierGenerator()
|
RegistryObject |
getLatestObject(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves the latest version of the RegistryObject with the given
logical identifier |
MetadataStore |
getMetadataStore()
Get access to the back end store for the registry service. |
RegistryObject |
getNextObject(String lid,
String versionId,
Class<? extends RegistryObject> objectClass)
Retrieves the next version of the RegsitryObject |
RegistryObject |
getObject(String guid,
Class<? extends RegistryObject> objectClass)
Retrieves a registry object of the requested type |
RegistryObject |
getObject(String lid,
String versionId,
Class<? extends RegistryObject> objectClass)
Retrieves a RegistryObject from the registry with the given
identifying information. |
RegistryResponse |
getObjects(ObjectQuery query,
Integer start,
Integer rows,
Class<? extends RegistryObject> objectClass)
Generic query for a given class of registry objects. |
List<RegistryObject> |
getObjectVersions(String lid,
Class<? extends RegistryObject> objectClass)
Retrieves all versions of a RegistryObject |
RegistryObject |
getPreviousObject(String lid,
String versionId,
Class<? extends RegistryObject> objectClass)
Retrieves the previous version of the RegistryObject |
Report |
getReport()
Gives back some basic summary information about the registry. |
Versioner |
getVersioner()
|
String |
publishObject(String user,
RegistryObject registryObject)
Publishes a registry object to the registry. |
String |
publishObject(String user,
RegistryObject registryObject,
String packageId)
Publishes a registry object to the registry. |
void |
setIdentifierGenerator(IdentifierGenerator idGenerator)
Sets the class used to generate unique ids for registry objects |
void |
setMetadataStore(MetadataStore metadataStore)
Set where to store all the metadata for registry objects. |
void |
setVersioner(Versioner versioner)
Sets the class used to generate and sort versions for registry objects. |
void |
updateObject(String user,
RegistryObject registryObject)
This method allows one to update all the metadata associated with a registry object. |
String |
versionObject(String user,
String lid,
RegistryObject object,
boolean major)
Versions a RegistryObject in the registry and publishes the
contents of the provided extrinsic object. |
Method Detail |
---|
void setMetadataStore(MetadataStore metadataStore)
metadataStore
- for registry object metadataMetadataStore getMetadataStore()
void setVersioner(Versioner versioner)
versioner
- to use when generating a new version of a registry object.Versioner getVersioner()
void setIdentifierGenerator(IdentifierGenerator idGenerator)
idGenerator
- to use to generate a guid for registry objects when there is not
one supplied by clients.IdentifierGenerator getIdentifierGenerator()
RegistryResponse getExtrinsics(Integer start, Integer rows)
ExtrinsicObject
's in the
registry.
start
- the index at which to start the result list fromrows
- how many results to return
RegistryResponse getExtrinsics(ExtrinsicQuery query)
query
- holds a set of filters to match against extrinsics
RegistryResponse getExtrinsics(ExtrinsicQuery query, Integer start, Integer rows)
query
- holds a set of filters to match against ExtrinsicObject
'sstart
- the index at which to start the result list from. This index
starts at one and if anything less than one is provided it will
default to one.rows
- how many results to return
Report getReport()
String versionObject(String user, String lid, RegistryObject object, boolean major) throws RegistryServiceException
RegistryObject
in the registry and publishes the
contents of the provided extrinsic object.
user
- that has taken the action. Typically this should point to a unique
username.lid
- logical identifier of the parent extrinsic objectobject
- the contents for this version of the extrinsic objectmajor
- flag to indicate whether this is a minor or major version
RegistryServiceException
RegistryObject getLatestObject(String lid, Class<? extends RegistryObject> objectClass)
RegistryObject
with the given
logical identifier
lid
- of extrinsic to look up
RegistryObject getEarliestObject(String lid, Class<? extends RegistryObject> objectClass)
RegsitryObject
with the given
logical identifier
lid
- of registry object to look upobjectClass
- the type of object to look up
RegistryObject getNextObject(String lid, String versionId, Class<? extends RegistryObject> objectClass)
RegsitryObject
lid
- of the current registry objectversionId
- of the current registry object. This is the user provided version.objectClass
- the type of object to look up
RegistryObject getPreviousObject(String lid, String versionId, Class<? extends RegistryObject> objectClass)
RegistryObject
lid
- of the current registry objectversionId
- of the current registry version. This is the user provided
version.objectClass
- the type of object to look up
List<RegistryObject> getObjectVersions(String lid, Class<? extends RegistryObject> objectClass)
RegistryObject
lid
- of the registry object of interestobjectClass
- the type of object to look up
RegistryObject getObject(String lid, String versionId, Class<? extends RegistryObject> objectClass)
RegistryObject
from the registry with the given
identifying information.
lid
- of the registry object of interest.versionId
- of the registry object of interest. This is the user provided
version.objectClass
- the type of object to look up
List<ClassificationNode> getClassificationNodes(String scheme)
ClassificationNode
for a given
ClassificationScheme
scheme
- guid for which to get the classification nodes for
void changeObjectStatus(String user, String lid, String versionId, ObjectAction action, Class<? extends RegistryObject> objectClass)
RegistryObject
status with the given identifying
information.
user
- that is requesting the changelid
- logical identifier of the extrinsicversionId
- of the registry object. This is the user supplied versionaction
- which to take (i.e. approve, deprecate, etc.)objectClass
- identifies the type of registry objectvoid changeObjectStatus(String user, String guid, ObjectAction action, Class<? extends RegistryObject> objectClass)
user
- that is requesting the changeguid
- of the registry object to uniquely identify itaction
- which to take (i.e. approve, deprecate, etc.)objectClass
- identifies the type of registry objectvoid updateObject(String user, RegistryObject registryObject)
user
- that is requesting the updateregistryObject
- to update too. The update is made to the object with the same guidRegistryResponse getAssociations(AssociationQuery query, Integer start, Integer rows)
query
- holds a set of filters to match against Association
'sstart
- the index at which to start the result list from. This index
starts at one and if anything less than one is provided it will
default to one.rows
- how many results to return
RegistryResponse getObjects(ObjectQuery query, Integer start, Integer rows, Class<? extends RegistryObject> objectClass)
query
- based on a set of filtersstart
- index within the results to start at. This index is one basedrows
- number of results to getobjectClass
- the type of registry object to look for
RegistryObject
with the given classRegistryResponse getAuditableEvents(String affectedObject)
affectedObject
- guid for the registry object of interest
String publishObject(String user, RegistryObject registryObject) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publish
RegistryServiceException
String publishObject(String user, RegistryObject registryObject, String packageId) throws RegistryServiceException
user
- that is requesting the object to be publishedregistryObject
- to publishpackageId
- to associate this publish event with
RegistryServiceException
void deleteObject(String user, String lid, String versionId, Class<? extends RegistryObject> objectClass)
RegistryObject
from the registry which share the logical
identifier and version.
user
- that requested the deletelid
- logical identifier of registry objectversionId
- user defined version for the registry objectobjectClass
- type of registry objectvoid deleteObject(String user, String guid, Class<? extends RegistryObject> objectClass)
RegistryObject
from the registry which share the logical
identifier and version.
user
- that requested the deleteguid
- globally unique identifier of the registry objectobjectClass
- type of registry objectAssociation getAssocation(String guid)
Association
from the registry with the given guid
guid
- globally unique identifier of the registry object
ExtrinsicObject getExtrinsic(String guid)
ExtrinsicObject
from the registry
guid
- globally unique identifier of the extrinsic object
RegistryObject getObject(String guid, Class<? extends RegistryObject> objectClass)
guid
- globally unique identifier of the objectobjectClass
- type of the registry object
String configure(String user, RegistryPackage registryPackage, List<? extends RegistryObject> list) throws RegistryServiceException
user
- that has taken the action. Typically this should point to a unique
username.registryPackage
- to associate objects tolist
- classification schemes and nodes that are apart of this config
RegistryServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |