edu.internet2.middleware.grouper.attr
Class AttributeDefName

java.lang.Object
  edu.internet2.middleware.grouper.GrouperAPI
      edu.internet2.middleware.grouper.attr.AttributeDefName

All Implemented Interfaces:

GrouperSetElement, HibGrouperLifecycle, Hib3GrouperVersioned, GrouperCloneable, GrouperHasContext, GrouperId, GrouperObject, GrouperUtil.FieldValuable, XmlImportable<AttributeDefName>, XmlImportableBase<AttributeDefName>, Serializable, Comparable<AttributeDefName>, org.hibernate.classic.Lifecycle

public class AttributeDefName
extends GrouperAPI
implements GrouperHasContext, Hib3GrouperVersioned, GrouperSetElement, XmlImportable<AttributeDefName>, Comparable<AttributeDefName>, GrouperObject

definition of an attribute name (is linked with an attribute def)

Author:

mchyzer

See Also:

Serialized Form

VALIDATION_NAME_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

public static final String VALIDATION_NAME_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

See Also:

Constant Field Values

VALIDATION_DISPLAY_NAME_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

public static final String VALIDATION_DISPLAY_NAME_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

See Also:

Constant Field Values

VALIDATION_DECRIPTION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

public static final String VALIDATION_DECRIPTION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

See Also:

Constant Field Values

VALIDATION_EXTENSION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

public static final String VALIDATION_EXTENSION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

See Also:

Constant Field Values

VALIDATION_DISPLAY_EXTENSION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

public static final String VALIDATION_DISPLAY_EXTENSION_OF_ATTRIBUTE_DEF_NAME_TOO_LONG_KEY

See Also:

Constant Field Values

TABLE_GROUPER_ATTRIBUTE_DEF_NAME

public static final String TABLE_GROUPER_ATTRIBUTE_DEF_NAME

name of the groups attribute def name table in the db

See Also:

Constant Field Values

COLUMN_ATTRIBUTE_DEF_ID

public static final String COLUMN_ATTRIBUTE_DEF_ID

column

See Also:

Constant Field Values

COLUMN_CONTEXT_ID

public static final String COLUMN_CONTEXT_ID

column

See Also:

Constant Field Values

COLUMN_CREATED_ON

public static final String COLUMN_CREATED_ON

column

See Also:

Constant Field Values

COLUMN_LAST_UPDATED

public static final String COLUMN_LAST_UPDATED

column

See Also:

Constant Field Values

COLUMN_DESCRIPTION

public static final String COLUMN_DESCRIPTION

column

See Also:

Constant Field Values

COLUMN_EXTENSION

public static final String COLUMN_EXTENSION

column

See Also:

Constant Field Values

COLUMN_NAME

public static final String COLUMN_NAME

column

See Also:

Constant Field Values

COLUMN_DISPLAY_EXTENSION

public static final String COLUMN_DISPLAY_EXTENSION

column

See Also:

Constant Field Values

COLUMN_DISPLAY_NAME

public static final String COLUMN_DISPLAY_NAME

column

See Also:

Constant Field Values

COLUMN_STEM_ID

public static final String COLUMN_STEM_ID

column

See Also:

Constant Field Values

COLUMN_ID

public static final String COLUMN_ID

column

See Also:

Constant Field Values

COLUMN_ID_INDEX

public static final String COLUMN_ID_INDEX

unique number for this attributeDefName

See Also:

Constant Field Values

FIELD_ATTRIBUTE_DEF_ID

public static final String FIELD_ATTRIBUTE_DEF_ID

constant for field name for: attributeDefId

See Also:

Constant Field Values

FIELD_CONTEXT_ID

public static final String FIELD_CONTEXT_ID

constant for field name for: contextId

See Also:

Constant Field Values

FIELD_CREATED_ON_DB

public static final String FIELD_CREATED_ON_DB

constant for field name for: createdOnDb

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

constant for field name for: description

See Also:

Constant Field Values

FIELD_DISPLAY_EXTENSION

public static final String FIELD_DISPLAY_EXTENSION

constant for field name for: displayExtension

See Also:

Constant Field Values

FIELD_DISPLAY_NAME

public static final String FIELD_DISPLAY_NAME

constant for field name for: displayName

See Also:

Constant Field Values

FIELD_EXTENSION

public static final String FIELD_EXTENSION

constant for field name for: extension

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

constant for field name for: id

See Also:

Constant Field Values

FIELD_ID_INDEX

public static final String FIELD_ID_INDEX

constant for field name for: idIndex

See Also:

Constant Field Values

FIELD_LAST_UPDATED_DB

public static final String FIELD_LAST_UPDATED_DB

constant for field name for: lastUpdatedDb

See Also:

Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

constant for field name for: name

See Also:

Constant Field Values

FIELD_STEM_ID

public static final String FIELD_STEM_ID

constant for field name for: stemId

See Also:

Constant Field Values

AttributeDefName

public AttributeDefName()

assertCanAdminAttributeDefStatic

public void assertCanAdminAttributeDefStatic()

make sure this attribute def can admin from grouper session

clone

public AttributeDefName clone()

deep clone the fields in this object

Specified by:

clone in interface GrouperCloneable

Specified by:

clone in class GrouperAPI

Returns:

the clone of the object

See Also:

Object.clone()

getAttributeDef

public AttributeDef getAttributeDef()

get the attribute def

Returns:

the attribute def

getStem

public Stem getStem()

stem that this attribute is in

Returns:

the stem id

getParentUuid

public String getParentUuid()

this method makes this class more compatible with Group and Stem

Returns:

the parent stem id

getStemId

public String getStemId()

stem that this attribute is in

Returns:

the stem id

setStemId

public void setStemId(String stemId1)

stem that this attribute is in

Parameters:

stemId1 -

getContextId

public String getContextId()

context id of the transaction

Returns:

context id

setContextId

public void setContextId(String contextId1)

context id of the transaction

Specified by:

setContextId in interface GrouperHasContext

Parameters:

contextId1 -

getId

public String getId()

id of this attribute def name

Specified by:

getId in interface GrouperId

Returns:

id

getUuid

public String getUuid()

id of this attribute def name

Returns:

id

setId

public void setId(String id1)

id of this attribute def name

Parameters:

id1 -

getName

public String getName()

Description copied from interface: GrouperObject

name of object, e.g. a:b:c

Specified by:

getName in interface GrouperObject

Returns:

the name

setName

public void setName(String name1)

Parameters:

name1 -

getNameDb

public String getNameDb()

Returns:

the name

setNameDb

public void setNameDb(String name1)

Parameters:

name1 -

getDescription

public String getDescription()

description of attribute, friendly description, e.g. in sentence form, about what the attribute is about

Specified by:

getDescription in interface GrouperObject

Returns:

the description

setDescription

public void setDescription(String description1)

description of attribute, friendly description, e.g. in sentence form, about what the attribute is about

Parameters:

description1 -

getDisplayExtension

public String getDisplayExtension()

displayExtension of attribute, e.g. Expire Date

Returns:

display extension

setDisplayExtension

public void setDisplayExtension(String displayExtension1)

displayExtension of attribute, e.g. Expire Date

Parameters:

displayExtension1 -

getDisplayName

public String getDisplayName()

displayName of attribute, e.g. My School:Community Groups:Expire Date

Specified by:

getDisplayName in interface GrouperObject

Returns:

display name

setDisplayName

public void setDisplayName(String displayName1)

displayName of attribute, e.g. My School:Community Groups:Expire Date

Parameters:

displayName1 -

getExtension

public String getExtension()

extension of attribute expireTime

Returns:

extension

setExtension

public void setExtension(String extension1)

extension of attribute expireTime

Parameters:

extension1 -

getExtensionDb

public String getExtensionDb()

extension of attribute expireTime

Returns:

extension

setExtensionDb

public void setExtensionDb(String extension1)

extension of attribute expireTime

Parameters:

extension1 -

getLastUpdated

public Timestamp getLastUpdated()

when last updated

Returns:

timestamp

getLastUpdatedDb

public Long getLastUpdatedDb()

when last updated

Returns:

timestamp

getCreatedOn

public Timestamp getCreatedOn()

when created

Returns:

timestamp

getCreatedOnDb

public Long getCreatedOnDb()

when created

Returns:

timestamp

setLastUpdated

public void setLastUpdated(Timestamp lastUpdated1)

when last updated

Parameters:

lastUpdated1 -

setLastUpdatedDb

public void setLastUpdatedDb(Long lastUpdated1)

when last updated

Parameters:

lastUpdated1 -

setCreatedOn

public void setCreatedOn(Timestamp createdOn1)

when created

Parameters:

createdOn1 -

setCreatedOnDb

public void setCreatedOnDb(Long createdOn1)

when created

Parameters:

createdOn1 -

getDisplayExtensionDb

public String getDisplayExtensionDb()

displayExtension of attribute, e.g. Expire Date

Returns:

display extension

setDisplayExtensionDb

public void setDisplayExtensionDb(String displayExtension1)

displayExtension of attribute, e.g. Expire Date

Parameters:

displayExtension1 -

getDisplayNameDb

public String getDisplayNameDb()

displayName of attribute, e.g. My School:Community Groups:Expire Date

Returns:

display name

setDisplayNameDb

public void setDisplayNameDb(String displayName1)

displayName of attribute, e.g. My School:Community Groups:Expire Date

Parameters:

displayName1 -

getAttributeDefId

public String getAttributeDefId()

attribute definition that this is related to

Returns:

the attribute def id

setAttributeDefId

public void setAttributeDefId(String attributeDefId1)

attribute def id that this is related to

Parameters:

attributeDefId1 -

__getId

public String __getId()

Description copied from interface: GrouperSetElement

if of this object

Specified by:

__getId in interface GrouperSetElement

Returns:

id

See Also:

GrouperSetElement.__getId()

__getName

public String __getName()

Description copied from interface: GrouperSetElement

name of this object (for logging)

Specified by:

__getName in interface GrouperSetElement

Returns:

name

See Also:

GrouperSetElement.__getName()

delete

public void delete()

save or update this object

getAttributeDefNameSetDelegate

public AttributeDefNameSetDelegate getAttributeDefNameSetDelegate()

delegate logic about attribute def name sets to this object

Returns:

the delegate

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

hashcode

Since:

1.2.0

xmlCopyBusinessPropertiesToExisting

public void xmlCopyBusinessPropertiesToExisting(AttributeDefName existingRecord)

Description copied from interface: XmlImportableBase

copy business (non update) properties to an existing record

Specified by:

xmlCopyBusinessPropertiesToExisting in interface XmlImportableBase<AttributeDefName>

See Also:

XmlImportableBase.xmlCopyBusinessPropertiesToExisting(java.lang.Object)

xmlDifferentBusinessProperties

public boolean xmlDifferentBusinessProperties(AttributeDefName other)

Description copied from interface: XmlImportableBase

see if the non update cols are different (e.g. name)

Specified by:

xmlDifferentBusinessProperties in interface XmlImportableBase<AttributeDefName>

Parameters:

other - the one to compare with

Returns:

true if so

See Also:

XmlImportableBase.xmlDifferentBusinessProperties(java.lang.Object)

xmlDifferentUpdateProperties

public boolean xmlDifferentUpdateProperties(AttributeDefName other)

Description copied from interface: XmlImportableBase

see if the update cols are different (e.g. last updated)

Specified by:

xmlDifferentUpdateProperties in interface XmlImportableBase<AttributeDefName>

Parameters:

other - the one to compare with

Returns:

true if so

See Also:

XmlImportableBase.xmlDifferentUpdateProperties(java.lang.Object)

xmlRetrieveByIdOrKey

public AttributeDefName xmlRetrieveByIdOrKey()

Description copied from interface: XmlImportable

retrieve from db by id or key. throws exception if duplicate

Specified by:

xmlRetrieveByIdOrKey in interface XmlImportable<AttributeDefName>

Returns:

the object or null if not found

See Also:

XmlImportable.xmlRetrieveByIdOrKey()

xmlSaveBusinessProperties

public AttributeDefName xmlSaveBusinessProperties(AttributeDefName existingRecord)

Description copied from interface: XmlImportableBase

save the business properties (not update properties)

Specified by:

xmlSaveBusinessProperties in interface XmlImportableBase<AttributeDefName>

Parameters:

existingRecord - null if insert, the object if exists in DB generally just copy the hibernate version number, and last updated to the object and store it

Returns:

the new object or existing

See Also:

XmlImportableBase.xmlSaveBusinessProperties(java.lang.Object)

xmlSaveUpdateProperties

public void xmlSaveUpdateProperties()

Description copied from interface: XmlImportableBase

save the udpate properties (e.g. last updated). Note, this is done with a sql update statement, not with hibernate

Specified by:

xmlSaveUpdateProperties in interface XmlImportableBase<AttributeDefName>

See Also:

XmlImportableBase.xmlSaveUpdateProperties()

xmlToExportAttributeDefName

public XmlExportAttributeDefName xmlToExportAttributeDefName(GrouperVersion grouperVersion)

convert to xml bean for export

Parameters:

grouperVersion -

Returns:

xml bean

xmlGetId

public String xmlGetId()

Description copied from interface: XmlImportableBase

set id key in db

Specified by:

xmlGetId in interface XmlImportableBase<AttributeDefName>

Returns:

id

See Also:

XmlImportableBase.xmlGetId()

xmlSetId

public void xmlSetId(String theId)

Description copied from interface: XmlImportableBase

set id key in db

Specified by:

xmlSetId in interface XmlImportableBase<AttributeDefName>

See Also:

XmlImportableBase.xmlSetId(java.lang.String)

xmlToString

public String xmlToString()

Description copied from interface: XmlImportableBase

convert to string for log

Specified by:

xmlToString in interface XmlImportableBase<AttributeDefName>

Returns:

the string value for log

See Also:

XmlImportableBase.xmlToString()

store

public void store()

store this group (update) to database

validate

public void validate()

onPostDelete

public void onPostDelete(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

after a delete occurs

Specified by:

onPostDelete in interface HibGrouperLifecycle

Overrides:

onPostDelete in class GrouperAPI

See Also:

GrouperAPI.onPostDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)

onPostSave

public void onPostSave(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

after a save (insert) occurs

Specified by:

onPostSave in interface HibGrouperLifecycle

Overrides:

onPostSave in class GrouperAPI

See Also:

HibGrouperLifecycle.onPostSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)

onPostUpdate

public void onPostUpdate(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

after an update occurs

Specified by:

onPostUpdate in interface HibGrouperLifecycle

Overrides:

onPostUpdate in class GrouperAPI

See Also:

HibGrouperLifecycle.onPostUpdate(HibernateSession)

onPreDelete

public void onPreDelete(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

before a delete (insert) occurs

Specified by:

onPreDelete in interface HibGrouperLifecycle

Overrides:

onPreDelete in class GrouperAPI

See Also:

GrouperAPI.onPreDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)

onPreSave

public void onPreSave(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

before a save (insert) occurs

Specified by:

onPreSave in interface HibGrouperLifecycle

Overrides:

onPreSave in class GrouperAPI

See Also:

GrouperAPI.onPreSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)

onPreUpdate

public void onPreUpdate(HibernateSession hibernateSession)

Description copied from interface: HibGrouperLifecycle

before an update occurs

Specified by:

onPreUpdate in interface HibGrouperLifecycle

Overrides:

onPreUpdate in class GrouperAPI

See Also:

GrouperAPI.onPreUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)

dbVersion

public AttributeDefName dbVersion()

save the state when retrieving from DB

Overrides:

dbVersion in class GrouperAPI

Returns:

the dbVersion

dbVersionReset

public void dbVersionReset()

take a snapshot of the data since this is what is in the db

Overrides:

dbVersionReset in class GrouperAPI

dbVersionDifferentFields

public Set<String> dbVersionDifferentFields()

Description copied from class: GrouperAPI

see which fields have changed compared to the DB state (last known) note that attributes will print out: attribute__attributeName

Overrides:

dbVersionDifferentFields in class GrouperAPI

Returns:

a set of attributes changed, or empty set if none

See Also:

GrouperAPI.dbVersionDifferentFields()

compareTo

public int compareTo(AttributeDefName that)

Specified by:

compareTo in interface Comparable<AttributeDefName>

See Also:

Comparable.compareTo(Object)

getIdIndex

public Long getIdIndex()

id of the group as a unique integer

Returns:

id

setIdIndex

public void setIdIndex(Long idIndex1)

id of the group as a unique integer

Parameters:

idIndex1 -

assignIdIndex

public boolean assignIdIndex(long theIdIndex)

assign different id index

Parameters:

theIdIndex -

Returns:

if it was changed

internalSetAttributeDef

public void internalSetAttributeDef(AttributeDef attributeDef1)

set this for caching

Parameters:

attributeDef1 -

getLegacyAttributeName

public String getLegacyAttributeName(boolean exceptionIfNotLegacyAttribute)

Parameters:

exceptionIfNotLegacyAttribute -

Returns:

legacy attribute name

getLegacyGroupTypeName

public String getLegacyGroupTypeName(boolean exceptionIfNotLegacyGroupType)

Parameters:

exceptionIfNotLegacyGroupType -

Returns:

legacy attribute name

matchesLowerSearchStrings

public boolean matchesLowerSearchStrings(Set<String> filterStrings)

Description copied from interface: GrouperObject

see if this object matches the filter strings

Specified by:

matchesLowerSearchStrings in interface GrouperObject

Returns:

true if matches

See Also:

GrouperObject.matchesLowerSearchStrings(Set)