rdapit.pitservice

Interface ITypingService

All Superinterfaces:

IIdentifierSystem

All Known Implementing Classes:

TypingService

public interface ITypingService
extends IIdentifierSystem

Core interface for clients to contact. Implementations will provide the necessary fixation in a concrete protocol (e.g. HTTP-REST).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	conformsToType(String pid, String typeIdentifier)
PropertyDefinition	describeProperty(String propertyIdentifier) Retrieves a property definition
TypeDefinition	describeType(String typeIdentifier) Retrieves a type definition
EntityClass	determineEntityClass(String identifier) Determines whether the given identifier references a simple object, a property, a type etc.
Object	genericResolve(String pid) Resolves the given PID without previous knowledge about the kind of entity it identifies (e.g. a common PID record, a property or type definition etc.).
PIDInformation	queryByType(String pid, String typeIdentifier, boolean includePropertyNames) Queries all properties of a type available from the given PID.
PIDInformation	queryByTypeWithConformance(String pid, List<String> typeIdentifiers, boolean includePropertyNames)
PIDInformation	queryByTypeWithConformance(String pid, String typeIdentifier, boolean includePropertyNames) Same as queryByType(java.lang.String, java.lang.String, boolean), but also performs a type conformance check.
PIDInformation	queryProperty(String pid, String propertyIdentifier) Queries a single property from the PID.

Methods inherited from interface rdapit.pidsystem.IIdentifierSystem

deletePID, isIdentifierRegistered, queryAllProperties, queryByType, queryProperty, registerPID

Method Detail

describeProperty

PropertyDefinition describeProperty(String propertyIdentifier)
                                    throws IOException

Retrieves a property definition

Parameters:

propertyIdentifier -

Returns:

null if there is no property with given identifier, the definition record otherwise.

Throws:

IOException

describeType

TypeDefinition describeType(String typeIdentifier)
                            throws IOException

Retrieves a type definition

Parameters:

typeIdentifier -

Returns:

null if there is no type with given identifier, the definition record otherwise.

Throws:

IOException

conformsToType

boolean conformsToType(String pid,
                     String typeIdentifier)
                       throws IOException

Throws:

IOException

genericResolve

Object genericResolve(String pid)
                      throws IOException

Resolves the given PID without previous knowledge about the kind of entity it identifies (e.g. a common PID record, a property or type definition etc.).

Parameters:

pid -

Returns:

The returned object can be either a PID record, a property definition or a type definition. It can also be null, indicating the PID is not registered at all.

Throws:

IOException

queryProperty

PIDInformation queryProperty(String pid,
                           String propertyIdentifier)
                             throws IOException

Queries a single property from the PID.

Parameters:

pid -

propertyIdentifier - must be registered in the type registry

Returns:

a PIDInformation object containing the single property name and value or null if the property is undefined.

Throws:

IOException

IllegalArgumentException - if the property is defined but ambiguous (type registry query returned multiple results).

queryByType

PIDInformation queryByType(String pid,
                         String typeIdentifier,
                         boolean includePropertyNames)
                           throws IOException,
                                  InconsistentRecordsException

Queries all properties of a type available from the given PID. If optional properties are present, they will be returned as well. If there are mandatory properties missing (i.e. the record of the given PID does not fully conform to the type), the method will NOT fail but simply return only those properties that are present.

Parameters:

pid -

typeIdentifier - a type identifier, not a name

includePropertyNames - if true, the method will also return property names at additional call costs.

Returns:

a PID information record with property identifiers mapping to values. Contains all property values present in the record of the given PID that are also specified by the type (mandatory or optional). If the pid is not registered, the method returns null.

Throws:

IOException

InconsistentRecordsException

queryByTypeWithConformance

PIDInformation queryByTypeWithConformance(String pid,
                                        String typeIdentifier,
                                        boolean includePropertyNames)
                                          throws IOException,
                                                 InconsistentRecordsException

Same as queryByType(java.lang.String, java.lang.String, boolean), but also performs a type conformance check. The result of the check will be available from the PID information record returned.

Parameters:

pid -

typeIdentifier -

includePropertyNames -

Returns:

a PID information record with property information and conformance check results.

Throws:

IOException

InconsistentRecordsException

queryByTypeWithConformance

PIDInformation queryByTypeWithConformance(String pid,
                                        List<String> typeIdentifiers,
                                        boolean includePropertyNames)
                                          throws IOException,
                                                 InconsistentRecordsException

Throws:

IOException

InconsistentRecordsException

determineEntityClass

EntityClass determineEntityClass(String identifier)
                                 throws IOException

Determines whether the given identifier references a simple object, a property, a type etc. Note that the method may contact a remote registry to answer the request since information may not be encoded in the identifier string.

Parameters:

identifier -

Returns:

a value of EntityClass

Throws:

IOException