KrmsTypeRepositoryService

Name KrmsTypeRepository
Version
Included Services  
Java Package org.kuali.rice.krms.api.repository.type

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Operations
Main Message Structures

Method createKrmsType
Description This will create a {@link KrmsTypeDefinition} exactly like the parameter passed in.
Parameters KrmsTypeDefinition krmsType - KrmsType
Return KrmsTypeDefinition ???
Errors RiceIllegalArgumentException ???
RiceIllegalStateException ???

Back to Operations

Method updateKrmsType
Description This will update an existing {@link KrmsTypeDefinition}
Parameters KrmsTypeDefinition krmsType - KrmsType
Return KrmsTypeDefinition ???
Errors RiceIllegalArgumentException ???
RiceIllegalStateException ???

Back to Operations

Method getTypeById
Description Lookup a krms type based on the given id.
Parameters String id the given KRMS type id
Return KrmsTypeDefinition a KRMS KrmsType object with the given id. A null reference is returned if an invalid or
non-existant id is supplied.
Errors RiceIllegalArgumentException ???

Back to Operations

Method getTypeByName
Description Get a krms type object based on name and namespace
Parameters String namespaceCode the given type namespace
String name the given type name
Return KrmsTypeDefinition A krms type object with the given namespace and name if one with that name and namespace
exists. Otherwise, null is returned.
Errors RiceIllegalArgumentException ???
RiceIllegalStateException ???

Back to Operations

Method findAllTypesByNamespace
Description Returns all KRMS types that for a given namespace.
Parameters String namespaceCode ???
Return KrmsTypeDefinitionList all KRMS types for a namespace
Errors RiceIllegalArgumentException ???

Back to Operations

Method findAllTypes
Description Returns all KRMS types
Parameters None None No Parameters
Return KrmsTypeDefinitionList all KRMS types
Errors NONE No Errors

Back to Operations

Method findAllAgendaTypesByContextId
Description Returns all agenda types for the given contextId.
Parameters String contextId the id of the context
Return KrmsTypeDefinitionList all agenda types for the given contextId
Errors RiceIllegalArgumentException ???

Back to Operations

Method getAgendaTypeByAgendaTypeIdAndContextId
Description Return the agenda type by agendaItemId for the given contextId.
Parameters String agendaTypeId the id of the agendaType
String contextId the id of the context
Return KrmsTypeDefinition agendaType or null if none is found
Errors RiceIllegalArgumentException ???

Back to Operations

Method findAllRuleTypesByContextId
Description Returns all rule types for the given contextId.
Parameters String contextId the id of the context
Return KrmsTypeDefinitionList all rule types for the given contextId
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRuleTypeByRuleTypeIdAndContextId
Description Return the rule type by ruleItemId for the given contextId.
Parameters String ruleTypeId the id of the ruleType
String contextId the id of the context
Return KrmsTypeDefinition ruleType or null if none is found
Errors RiceIllegalArgumentException ???

Back to Operations

Method findAllActionTypesByContextId
Description Returns all action types for the given contextId.
Parameters String contextId the id of the context
Return KrmsTypeDefinitionList all action types for the given contextId
Errors RiceIllegalArgumentException ???

Back to Operations

Method getActionTypeByActionTypeIdAndContextId
Description Return the action type by actionItemId for the given contextId.
Parameters String actionTypeId the id of the actionType
String contextId the id of the context
Return KrmsTypeDefinition actionType or null if none is found
Errors RiceIllegalArgumentException ???

Back to Operations

Method getAttributeDefinitionById
Description Retrieves an attribute definition for the given id.
Parameters String attributeDefinitionId the id of the attribute definition to retrieve
Return KrmsAttributeDefinition the attribute definition matching the given id, or null if no corresponding attribute definition could
be found with the given id value
Errors RiceIllegalArgumentException ???

Back to Operations

Method getAttributeDefinitionByName
Description Retrieves an attribute definition for the given namespace code and name.
Parameters String namespaceCode the namespace under which to locate the attribute definition
String name the name of the attribute definition to retrieve
Return KrmsAttributeDefinition the attribute definition matching the give namespace code and name, or null if no corresponding attribute
definition could be located
Errors RiceIllegalArgumentException if the given namespaceCode or name is a null or blank value

Back to Operations