uk.ac.soton.itinnovation.registry.icomponent.registration
Interface Registration

All Superinterfaces:
CredentialRequired
All Known Implementing Classes:
XmlRegistrationFacility

public interface Registration
extends CredentialRequired


Method Summary
 void deleteAllEntities()
          Removes all entities form the registry that are accessible by the user.
 void deleteEntity(String concept, String id)
          Removes an entity from the registry.
 void insertRelationship(String fromEntityId, String relationshipName, String toEntityId)
          Add a relationship between two entities stored.
 String registerEntity(String concept, Document content, String id)
          Registers an entity in the registry.
 String registerEntity(String concept, String content, String id)
          Registers an entity in the registry.
 String registerEntity(String concept, URI uri, String id)
          Registers an entity in the registry.
 
Methods inherited from interface uk.ac.soton.itinnovation.registry.icomponent.access.CredentialRequired
removeCredential, setCredential
 

Method Detail

registerEntity

String registerEntity(String concept,
                      URI uri,
                      String id)
                      throws RegistrationException,
                             AccessException
Registers an entity in the registry. Creates an update if the id used already exists.

Parameters:
concept - Concept to which the entity belongs
uri - URI of the entity
id - unique identifier. If the id is null, a new identifier will be automatically generated.
Returns:
the id of the entity in the registry
Throws:
RegistrationException
AccessException

registerEntity

String registerEntity(String concept,
                      String content,
                      String id)
                      throws RegistrationException,
                             AccessException
Registers an entity in the registry. Creates an update if the id used already exists.

Parameters:
concept - Concept to which the entity belongs
content - String content of entity
id - unique identifier. If the id is null, a new identifier will be automatically generated.
Returns:
the id of the entity in the registry
Throws:
RegistrationException
AccessException

registerEntity

String registerEntity(String concept,
                      Document content,
                      String id)
                      throws RegistrationException,
                             AccessException
Registers an entity in the registry. Creates an update if the id used already exists.

Parameters:
concept - Concept to which the entity belongs
content - DOM document of entity
id - unique identifier. If the id is null, a new identifier will be automatically generated.
Returns:
the id of the entity in the registry
Throws:
RegistrationException
AccessException

deleteEntity

void deleteEntity(String concept,
                  String id)
                  throws RegistrationException,
                         AccessException
Removes an entity from the registry.

Parameters:
concept -
id -
Throws:
RegistrationException
AccessException

deleteAllEntities

void deleteAllEntities()
                       throws RegistrationException,
                              AccessException
Removes all entities form the registry that are accessible by the user.

Throws:
RegistrationException
AccessException

insertRelationship

void insertRelationship(String fromEntityId,
                        String relationshipName,
                        String toEntityId)
                        throws RegistrationException,
                               AccessException
Add a relationship between two entities stored.

Parameters:
fromEntityId -
relationshipName -
toEntityId -
Throws:
RegistrationException
AccessException


Copyright © 2001-2007 University of Southampton IT Innovation Centre. All Rights Reserved.