org.kuali.rice.krms.api.repository.type

Interface KrmsTypeRepositoryService

public interface KrmsTypeRepositoryService

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENDA_SERVICE_NAME
static String	COMPOUND_PROPOSITION_SERVICE_NAME
static String	CONSTANT_VALUE_PROPOSITION_PARAMETER_SERVICE_NAME
static String	CONTEXT_SERVICE_NAME
static String	FUNCTION_PROPOSITION_PARAMETER_SERVICE_NAME
static String	OPERATOR_PROPOSITION_PARAMETER_SERVICE_NAME
static String[]	PROPOSITION_PARAMETER_SERVICE_NAMES
static String[]	PROPOSITION_SERVICE_NAMES
static String	RULE_SERVICE_NAME
static String	SIMPLE_PROPOSITION_SERVICE_NAME
static String	TERM_PARAMETER_SERVICE_NAME
static String	TERM_PROPOSITION_PARAMETER_SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
KrmsTypeDefinition	createKrmsType(KrmsTypeDefinition krmsType) This will create a KrmsTypeDefinition exactly like the parameter passed in.
TypeTypeRelation	createTypeTypeRelation(TypeTypeRelation typeTypeRelation) This will create a TypeTypeRelation exactly like the parameter passed in.
void	deleteTypeTypeRelation(String typeTypeRelationId) Delete the TypeTypeRelation with the given id.
List<KrmsTypeDefinition>	findAgendaTypesForAgendaType(String agendaTypeId) find all agenda types for context type
List<KrmsTypeDefinition>	findAgendaTypesForContextType(String contextTypeId) find all agenda types for context type
List<KrmsTypeDefinition>	findAllActionTypesByContextId(String contextId) Returns all action types for the given contextId.
List<KrmsTypeDefinition>	findAllAgendaTypes() find all agenda types
List<KrmsTypeDefinition>	findAllAgendaTypesByContextId(String contextId) Returns all agenda types for the given contextId.
List<KrmsTypeDefinition>	findAllContextTypes() find all context types
List<KrmsTypeDefinition>	findAllPropositionParameterTypes() find all Proposition Parameter types
List<KrmsTypeDefinition>	findAllPropositionTypes() find all Proposition types
List<KrmsTypeDefinition>	findAllRuleTypes() find all rule types
List<KrmsTypeDefinition>	findAllRuleTypesByContextId(String contextId) Returns all rule types for the given contextId.
List<KrmsTypeDefinition>	findAllTypes() Returns all KRMS types
List<KrmsTypeDefinition>	findAllTypesByNamespace(String namespaceCode) Returns all KRMS types that for a given namespace.
List<KrmsTypeDefinition>	findAllTypesByServiceName(String serviceName) Returns all KRMS types that for a given serviceName
List<KrmsTypeDefinition>	findPropositionParameterTypesForPropositionType(String propositionTypeId) find Proposition Parameter types for the specified proposition type
List<KrmsTypeDefinition>	findPropositionTypesForRuleType(String ruleTypeId) find all Proposition types for the specified rule type
List<KrmsTypeDefinition>	findRuleTypesForAgendaType(String agendaTypeId) find the rule types for the specified agenda type
List<KrmsTypeDefinition>	findTermParameterTypesForTermPropositionParameterType(String termPropositionParameterTypeId) find term parameter types for the given Term based Proposition Parameter type
List<TypeTypeRelation>	findTypeTypeRelationsByFromType(String fromTypeId) find type type relations by from type
List<TypeTypeRelation>	findTypeTypeRelationsByRelationshipType(RelationshipType relationshipType) find type type relations by relationship type
List<TypeTypeRelation>	findTypeTypeRelationsByToType(String toTypeId) find type type relations by To type
KrmsTypeDefinition	getActionTypeByActionTypeIdAndContextId(String actionTypeId, String contextId) Return the action type by actionItemId for the given contextId.
KrmsTypeDefinition	getAgendaTypeByAgendaTypeIdAndContextId(String agendaTypeId, String contextId) Return the agenda type by agendaItemId for the given contextId.
KrmsAttributeDefinition	getAttributeDefinitionById(String attributeDefinitionId) Retrieves an attribute definition for the given id.
KrmsAttributeDefinition	getAttributeDefinitionByName(String namespaceCode, String name) Retrieves an attribute definition for the given namespace code and name.
KrmsTypeDefinition	getRuleTypeByRuleTypeIdAndContextId(String ruleTypeId, String contextId) Return the rule type by ruleItemId for the given contextId.
KrmsTypeDefinition	getTypeById(String id) Lookup a krms type based on the given id.
KrmsTypeDefinition	getTypeByName(String namespaceCode, String name) Get a krms type object based on name and namespace
TypeTypeRelation	getTypeTypeRelation(String typeTypeRelationId) Retrieves a TypeTypeRelation from the repository based on the given id.
KrmsTypeDefinition	updateKrmsType(KrmsTypeDefinition krmsType) This will update an existing KrmsTypeDefinition
void	updateTypeTypeRelation(TypeTypeRelation typeTypeRelation) This will update an existing TypeTypeRelation.

Field Detail

CONTEXT_SERVICE_NAME

static final String CONTEXT_SERVICE_NAME

See Also:

Constant Field Values

AGENDA_SERVICE_NAME

static final String AGENDA_SERVICE_NAME

See Also:

Constant Field Values

RULE_SERVICE_NAME

static final String RULE_SERVICE_NAME

See Also:

Constant Field Values

SIMPLE_PROPOSITION_SERVICE_NAME

static final String SIMPLE_PROPOSITION_SERVICE_NAME

See Also:

Constant Field Values

COMPOUND_PROPOSITION_SERVICE_NAME

static final String COMPOUND_PROPOSITION_SERVICE_NAME

See Also:

Constant Field Values

TERM_PROPOSITION_PARAMETER_SERVICE_NAME

static final String TERM_PROPOSITION_PARAMETER_SERVICE_NAME

See Also:

Constant Field Values

OPERATOR_PROPOSITION_PARAMETER_SERVICE_NAME

static final String OPERATOR_PROPOSITION_PARAMETER_SERVICE_NAME

See Also:

Constant Field Values

CONSTANT_VALUE_PROPOSITION_PARAMETER_SERVICE_NAME

static final String CONSTANT_VALUE_PROPOSITION_PARAMETER_SERVICE_NAME

See Also:

Constant Field Values

FUNCTION_PROPOSITION_PARAMETER_SERVICE_NAME

static final String FUNCTION_PROPOSITION_PARAMETER_SERVICE_NAME

See Also:

Constant Field Values

PROPOSITION_SERVICE_NAMES

static final String[] PROPOSITION_SERVICE_NAMES

PROPOSITION_PARAMETER_SERVICE_NAMES

static final String[] PROPOSITION_PARAMETER_SERVICE_NAMES

TERM_PARAMETER_SERVICE_NAME

static final String TERM_PARAMETER_SERVICE_NAME

See Also:

Constant Field Values

Method Detail

createKrmsType

@CacheEvict(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
            allEntries=true)
KrmsTypeDefinition createKrmsType(KrmsTypeDefinition krmsType)
                                                                                                                          throws RiceIllegalArgumentException,
                                                                                                                                 RiceIllegalStateException

This will create a KrmsTypeDefinition exactly like the parameter passed in.

Parameters:

krmsType - - KrmsType

Throws:

IllegalArgumentException - if the krmsType is +

IllegalStateException - if the KrmsType already exists in the system

RiceIllegalArgumentException

RiceIllegalStateException

updateKrmsType

@CacheEvict(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
            allEntries=true)
KrmsTypeDefinition updateKrmsType(KrmsTypeDefinition krmsType)
                                                                                                                          throws RiceIllegalArgumentException,
                                                                                                                                 RiceIllegalStateException

This will update an existing KrmsTypeDefinition

Parameters:

krmsType - - KrmsType

Throws:

IllegalArgumentException - if the krmsType is null

IllegalStateException - if the KrmsType does not exist in the system

RiceIllegalArgumentException

RiceIllegalStateException

getTypeById

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'id=\' + #p0")
KrmsTypeDefinition getTypeById(String id)
                                                                                                                         throws RiceIllegalArgumentException

Lookup a krms type based on the given id.

Parameters:

id - the given KRMS type id

Returns:

a KRMS KrmsType object with the given id. A null reference is returned if an invalid or non-existant id is supplied.

Throws:

RiceIllegalArgumentException

getTypeByName

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'namespaceCode=\' + #p0 + \'|\' + \'name=\' + #p1")
KrmsTypeDefinition getTypeByName(String namespaceCode,
                                                                                                                                                                       String name)
                                                                                                                                                                throws RiceIllegalArgumentException,
                                                                                                                                                                       RiceIllegalStateException

Get a krms type object based on name and namespace

Parameters:

namespaceCode - the given type namespace

name - the given type name

Returns:

A krms type object with the given namespace and name if one with that name and namespace exists. Otherwise, null is returned.

Throws:

RiceIllegalArgumentException - if the given namespaceCode or name is a null or blank value

RiceIllegalStateException - if multiple krms types exist with the same name and namespace

findAllTypesByNamespace

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'allByNamespaceCode=\' + #p0")
List<KrmsTypeDefinition> findAllTypesByNamespace(String namespaceCode)
                                                                                                                                                           throws RiceIllegalArgumentException

Returns all KRMS types that for a given namespace.

Returns:

all KRMS types for a namespace

Throws:

IllegalArgumentException - if the given namespaceCode is a null or blank value

RiceIllegalArgumentException

findAllTypes

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'all\'")
List<KrmsTypeDefinition> findAllTypes()

Returns all KRMS types

Returns:

all KRMS types

findAllAgendaTypesByContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'{AgendaType}contextId=\' + #p0")
List<KrmsTypeDefinition> findAllAgendaTypesByContextId(String contextId)
                                                                                                                                                                    throws RiceIllegalArgumentException

Returns all agenda types for the given contextId.

Parameters:

contextId - the id of the context

Returns:

all agenda types for the given contextId

Throws:

IllegalArgumentException - if the given contextId is a null or blank value

RiceIllegalArgumentException

getAgendaTypeByAgendaTypeIdAndContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'agendaTypeId=\' + #p0 + \'|\' + \'contextId=\' + #p1")
KrmsTypeDefinition getAgendaTypeByAgendaTypeIdAndContextId(String agendaTypeId,
                                                                                                                                                                                                     String contextId)
                                                                                                                                                                                              throws RiceIllegalArgumentException

Return the agenda type by agendaItemId for the given contextId.

Parameters:

agendaTypeId - the id of the agendaType

contextId - the id of the context

Returns:

agendaType or null if none is found

Throws:

IllegalArgumentException - if the given agendaTypeId or contextId is a null or blank value

RiceIllegalArgumentException

findAllRuleTypesByContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'{RuleType}contextId=\' + #p0")
List<KrmsTypeDefinition> findAllRuleTypesByContextId(String contextId)
                                                                                                                                                                throws RiceIllegalArgumentException

Returns all rule types for the given contextId.

Parameters:

contextId - the id of the context

Returns:

all rule types for the given contextId

Throws:

IllegalArgumentException - if the given contextId is a null or blank value

RiceIllegalArgumentException

getRuleTypeByRuleTypeIdAndContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'ruleTypeId=\' + #p0 + \'|\' + \'contextId=\' + #p1")
KrmsTypeDefinition getRuleTypeByRuleTypeIdAndContextId(String ruleTypeId,
                                                                                                                                                                                               String contextId)
                                                                                                                                                                                        throws RiceIllegalArgumentException

Return the rule type by ruleItemId for the given contextId.

Parameters:

ruleTypeId - the id of the ruleType

contextId - the id of the context

Returns:

ruleType or null if none is found

Throws:

IllegalArgumentException - if the given ruleTypeId or contextId is a null or blank value

RiceIllegalArgumentException

findAllActionTypesByContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'{ActionType}contextId=\' + #p0")
List<KrmsTypeDefinition> findAllActionTypesByContextId(String contextId)
                                                                                                                                                                    throws RiceIllegalArgumentException

Returns all action types for the given contextId.

Parameters:

contextId - the id of the context

Returns:

all action types for the given contextId

Throws:

IllegalArgumentException - if the given contextId is a null or blank value

RiceIllegalArgumentException

getActionTypeByActionTypeIdAndContextId

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KRMSTypeType",
           key="\'actionTypeId=\' + #p0 + \'|\' + \'contextId=\' + #p1")
KrmsTypeDefinition getActionTypeByActionTypeIdAndContextId(String actionTypeId,
                                                                                                                                                                                                     String contextId)
                                                                                                                                                                                              throws RiceIllegalArgumentException

Return the action type by actionItemId for the given contextId.

Parameters:

actionTypeId - the id of the actionType

contextId - the id of the context

Returns:

actionType or null if none is found

Throws:

IllegalArgumentException - if the given actionTypeId or contextId is a null or blank value

RiceIllegalArgumentException

getAttributeDefinitionById

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KrmsAttributionDefinitionType",
           key="\'attributeDefinitionId=\' + #p0")
KrmsAttributeDefinition getAttributeDefinitionById(String attributeDefinitionId)
                                                                                                                                                                                 throws RiceIllegalArgumentException

Retrieves an attribute definition for the given id.

Parameters:

attributeDefinitionId - the id of the attribute definition to retrieve

Returns:

the attribute definition matching the given id, or null if no corresponding attribute definition could be found with the given id value

Throws:

IllegalArgumentException - if the given attributeDefinitionId is a null or blank value

RiceIllegalArgumentException

getAttributeDefinitionByName

@Cacheable(value="http://rice.kuali.org/krms/v2_0/KrmsAttributionDefinitionType",
           key="\'namespaceCode=\' + #p0 + \'|\' + \'name=\' + #p1")
KrmsAttributeDefinition getAttributeDefinitionByName(String namespaceCode,
                                                                                                                                                                                                            String name)
                                                                                                                                                                                                     throws RiceIllegalArgumentException

Retrieves an attribute definition for the given namespace code and name.

Parameters:

namespaceCode - the namespace under which to locate the attribute definition

name - the name of the attribute definition to retrieve

Returns:

the attribute definition matching the give namespace code and name, or null if no corresponding attribute definition could be located

Throws:

RiceIllegalArgumentException - if the given namespaceCode or name is a null or blank value

createTypeTypeRelation

TypeTypeRelation createTypeTypeRelation(TypeTypeRelation typeTypeRelation)
                                 throws RiceIllegalArgumentException

This will create a TypeTypeRelation exactly like the parameter passed in.

Parameters:

typeTypeRelation - The TypeTypeRelation to create.

Returns:

a TypeTypeRelation exactly like the parameter passed in.

Throws:

IllegalArgumentException - if the TypeTypeRelation is null.

IllegalStateException - if the TypeTypeRelation already exists in the system.

RiceIllegalArgumentException

getTypeTypeRelation

TypeTypeRelation getTypeTypeRelation(String typeTypeRelationId)
                              throws RiceIllegalArgumentException

Retrieves a TypeTypeRelation from the repository based on the given id.

Parameters:

typeTypeRelationId - to retrieve.

Returns:

a TypeTypeRelation identified by the given id. A null reference is returned if an invalid or non-existent id is supplied.

Throws:

RiceIllegalArgumentException

updateTypeTypeRelation

void updateTypeTypeRelation(TypeTypeRelation typeTypeRelation)
                     throws RiceIllegalArgumentException

This will update an existing TypeTypeRelation.

Parameters:

typeTypeRelation - The TypeTypeRelation to update.

Throws:

IllegalArgumentException - if the TypeTypeRelation is null.

IllegalStateException - if the TypeTypeRelation does not exists in the system.

RiceIllegalArgumentException

deleteTypeTypeRelation

void deleteTypeTypeRelation(String typeTypeRelationId)
                     throws RiceIllegalArgumentException

Delete the TypeTypeRelation with the given id.

Parameters:

typeTypeRelationId - to delete.

Throws:

IllegalArgumentException - if the TypeTypeRelation is null.

IllegalStateException - if the TypeTypeRelation does not exists in the system

RiceIllegalArgumentException

findTypeTypeRelationsByFromType

List<TypeTypeRelation> findTypeTypeRelationsByFromType(String fromTypeId)
                                                throws RiceIllegalArgumentException

find type type relations by from type

Parameters:

fromTypeId - to search on

Returns:

relations that match the from type

Throws:

RiceIllegalArgumentException

findTypeTypeRelationsByToType

List<TypeTypeRelation> findTypeTypeRelationsByToType(String toTypeId)
                                              throws RiceIllegalArgumentException

find type type relations by To type

Parameters:

toTypeId - to type to search on

Returns:

types with that type in the 2nd position in the relationship

Throws:

RiceIllegalArgumentException

findTypeTypeRelationsByRelationshipType

List<TypeTypeRelation> findTypeTypeRelationsByRelationshipType(RelationshipType relationshipType)
                                                        throws RiceIllegalArgumentException

find type type relations by relationship type

Parameters:

relationshipType - to search on

Returns:

type type relations given the specified type

Throws:

RiceIllegalArgumentException

findAllTypesByServiceName

List<KrmsTypeDefinition> findAllTypesByServiceName(String serviceName)
                                            throws RiceIllegalArgumentException

Returns all KRMS types that for a given serviceName

Returns:

all KRMS types for a serviceName

Throws:

IllegalArgumentException - if the given serviceName is a null or blank value

RiceIllegalArgumentException

findAllContextTypes

List<KrmsTypeDefinition> findAllContextTypes()
                                      throws RiceIllegalArgumentException

find all context types

Returns:

types that are valid for contexts

Throws:

RiceIllegalArgumentException

findAllAgendaTypes

List<KrmsTypeDefinition> findAllAgendaTypes()
                                     throws RiceIllegalArgumentException

find all agenda types

Returns:

types that are valid for agendas

Throws:

RiceIllegalArgumentException

findAgendaTypesForContextType

List<KrmsTypeDefinition> findAgendaTypesForContextType(String contextTypeId)
                                                throws RiceIllegalArgumentException

find all agenda types for context type

Parameters:

contextTypeId - to search on

Returns:

types that are valid for agendas

Throws:

RiceIllegalArgumentException

findAgendaTypesForAgendaType

List<KrmsTypeDefinition> findAgendaTypesForAgendaType(String agendaTypeId)
                                               throws RiceIllegalArgumentException

find all agenda types for context type

Parameters:

agendaTypeId - to search on

Returns:

types that are valid for agendas

Throws:

RiceIllegalArgumentException

findAllRuleTypes

List<KrmsTypeDefinition> findAllRuleTypes()
                                   throws RiceIllegalArgumentException

find all rule types

Returns:

types that are valid for rules

Throws:

RiceIllegalArgumentException

findRuleTypesForAgendaType

List<KrmsTypeDefinition> findRuleTypesForAgendaType(String agendaTypeId)
                                             throws RiceIllegalArgumentException

find the rule types for the specified agenda type

Parameters:

agendaTypeId - to search on

Returns:

types that are valid for rules

Throws:

RiceIllegalArgumentException

findAllPropositionTypes

List<KrmsTypeDefinition> findAllPropositionTypes()
                                          throws RiceIllegalArgumentException

find all Proposition types

Returns:

types that are valid for propositions

Throws:

RiceIllegalArgumentException

findPropositionTypesForRuleType

List<KrmsTypeDefinition> findPropositionTypesForRuleType(String ruleTypeId)
                                                  throws RiceIllegalArgumentException

find all Proposition types for the specified rule type

Parameters:

ruleTypeId - to search on

Returns:

types that are valid for propositions

Throws:

RiceIllegalArgumentException

findAllPropositionParameterTypes

List<KrmsTypeDefinition> findAllPropositionParameterTypes()
                                                   throws RiceIllegalArgumentException

find all Proposition Parameter types

Returns:

types that are valid for proposition parameters

Throws:

RiceIllegalArgumentException

findPropositionParameterTypesForPropositionType

List<KrmsTypeDefinition> findPropositionParameterTypesForPropositionType(String propositionTypeId)
                                                                  throws RiceIllegalArgumentException

find Proposition Parameter types for the specified proposition type

Parameters:

propositionTypeId - to search on

Returns:

types that are valid for proposition parameters

Throws:

RiceIllegalArgumentException

findTermParameterTypesForTermPropositionParameterType

List<KrmsTypeDefinition> findTermParameterTypesForTermPropositionParameterType(String termPropositionParameterTypeId)
                                                                        throws RiceIllegalArgumentException

find term parameter types for the given Term based Proposition Parameter type

Parameters:

termPropositionParameterTypeId - to search on

Returns:

types that are valid as term parameters

Throws:

RiceIllegalArgumentException