Persistable

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Persistable(java.lang.String classType, java.lang.String uid)` Constructor This is the preferred constructor and should be used whenever possible - most certainly in server code.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`createKey(java.lang.String classType)` For the specified class, returns a key for use in retrieving the corresponding persistable data.
`static java.lang.String`	`createKey(java.lang.String classType, java.lang.String uid)` For the specified class type and UID, returns a key for use in retrieving the corresponding persistable data.
`boolean`	`equals(java.lang.Object obj)` Determines whether another object contains the same data values as the current `Persistable` instance.
`static java.lang.String`	`extractType(java.lang.String key)` Returns the class type from a Persistence Key.
`static java.lang.String`	`extractUID(java.lang.String key)` Returns the unique identifier from a Persistence Key.
`java.lang.String`	`getKey()` Returns a key representing this persistable object in the following format: `@<class type>/<uid>`
`java.lang.String`	`getShortKey()` Alias for `HasUID.getUID()`
`static java.lang.String`	`getShortKey(java.lang.String persistenceKey)` Returns the unique identifier from a Persistence Key.
`java.lang.String`	`getType()` Returns, as a fully specified class name, the class type needed to store this persistable object.
`java.lang.String`	`getUID()` Returns the database UID for this persistable object.
`ValidatorUtilities`	`getValidatorUtilities()`
`void`	`setValidatorUtilities(ValidatorUtilities vu)`
`java.lang.String`	`toString()` Returns a string representation of this object.
`void`	`validate()` Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!
`static void`	`validateKey(java.lang.String key)` Validates a Persistence Key's format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Persistable
```
protected Persistable(java.lang.String classType,
                      java.lang.String uid)
```
    Constructor This is the preferred constructor and should be used whenever possible - most certainly in server code.
    
    Parameters:
    
    classType - Class type of the persistable object as a fully specified class name. For ex: org.assistments.core.domain.ProblemSet
    
    uid - Sets the database UID for this persistable object.
    
    See Also:
    
    getKey(), getType(), org.assistments.domain.content.tutor.persistence.HasUID#getUID()
- Method Detail
  - getUID
```
public java.lang.String getUID()
```
    Description copied from interface: HasUID
    
    Returns the database UID for this persistable object.
    
    Specified by:
    
    getUID in interface HasUID
  - getShortKey
```
public java.lang.String getShortKey()
```
    Description copied from interface: HasUID
    
    Alias for HasUID.getUID()
    
    Specified by:
    
    getShortKey in interface HasUID
  - getType
```
public java.lang.String getType()
```
    Returns, as a fully specified class name, the class type needed to store this persistable object.
    
    Specified by:
    
    getType in interface IsPersistable
    
    See Also:
    
    setType(String)
  - getKey
```
public java.lang.String getKey()
```
    Returns a key representing this persistable object in the following format:
    @<class type>/<uid>
    
    Specified by:
    
    getKey in interface IsPersistable
    
    See Also:
    
    getType(), org.assistments.domain.content.tutor.persistence.HasUID#getUID()
  - createKey
```
public static java.lang.String createKey(java.lang.String classType)
```
    For the specified class, returns a key for use in retrieving the corresponding persistable data. createKey includes a default core UID.
    
    Parameters:
    
    classType - fully specified class name
    
    Returns:
    
    a persistable key
    
    See Also:
    
    UIDGeneratorGWTImpl.generateDefaultUID(), createKey(String, String)
  - createKey
```
public static java.lang.String createKey(java.lang.String classType,
                                         java.lang.String uid)
```
    For the specified class type and UID, returns a key for use in retrieving the corresponding persistable data.
    
    Parameters:
    
    classType - fully specified class name
    
    uid - Unique Identifier
    
    Returns:
    
    A key of the form: @<class type>/<uid>
  - extractType
```
public static java.lang.String extractType(java.lang.String key)
```
    Returns the class type from a Persistence Key.
    
    Parameters:
    
    key - The persistence key
    
    Throws:
    
    java.lang.IllegalArgumentException - if key is improperly formatted.
  - extractUID
```
public static java.lang.String extractUID(java.lang.String key)
```
    Returns the unique identifier from a Persistence Key.
    
    Parameters:
    
    key - The persistence key
  - getShortKey
```
public static java.lang.String getShortKey(java.lang.String persistenceKey)
```
    Returns the unique identifier from a Persistence Key. This is an alias for extractUID(String).
    
    Parameters:
    
    persistenceKey - The persistence key
    
    See Also:
    
    extractUID(String)
  - validateKey
```
public static void validateKey(java.lang.String key)
                        throws java.lang.IllegalArgumentException
```
    Validates a Persistence Key's format.
    
    Parameters:
    
    key - Persistence key to validate
    
    Throws:
    
    java.lang.IllegalArgumentException - If the key is not in the expected format.
  - validate
```
public void validate()
              throws ValidationException
```
    Description copied from interface: SelfValidating
    
    Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!
    
    Specified by:
    
    validate in interface SelfValidating
    
    Throws:
    
    ValidationException - if the data is invalid
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether another object contains the same data values as the current Persistable instance.
    Equality is determined if all member fields, are identical. Please note that class type and UID compares are case sensitive.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if all fields are identical; otherwise false
  toString public java.lang.String toString() Returns a string representation of this object. Specified by: toString in interface IsPersistable Overrides: toString in class java.lang.Object setValidatorUtilities public void setValidatorUtilities(ValidatorUtilities vu) Specified by: setValidatorUtilities in interface IsPersistable getValidatorUtilities public ValidatorUtilities getValidatorUtilities() Specified by: getValidatorUtilities in interface IsPersistable

Class Persistable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Persistable

Method Detail

getUID

getShortKey

getType

getKey

createKey

createKey

extractType

extractUID

getShortKey

validateKey

validate

equals

toString

setValidatorUtilities

getValidatorUtilities