org.kuali.rice.coreservice.api.parameter
Class ParameterKey

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.coreservice.api.parameter.ParameterKey

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete

public final class ParameterKey
extends AbstractDataTransferObject

This class represents the 4-part key which uniquely identifies a parameter.

See Also:

ParameterContract, Parameter, Serialized Form

Method Summary

static ParameterKey	create(String applicationId, String namespaceCode, String componentCode, String name) Creates a ParameterKey from the given required values.
String	getApplicationId()
String	getCacheKey()
String	getComponentCode()
String	getName()
String	getNamespaceCode()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ParameterKey create(String applicationId,
                                  String namespaceCode,
                                  String componentCode,
                                  String name)

Creates a ParameterKey from the given required values.

Parameters:

applicationId - the application id, cannot be null or blank

namespaceCode - the namespace code, cannot be null or blank

componentCode - the component code, cannot be null or blank

name - the parameter name, cannot be null or blank

Returns:

the fully-constructed ParameterKey

Throws:

IllegalArgumentException - if any arguments are null or blank

getApplicationId

public String getApplicationId()

getNamespaceCode

public String getNamespaceCode()

getComponentCode

public String getComponentCode()

getName

public String getName()

getCacheKey

public String getCacheKey()