|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.GrouperAPI
edu.internet2.middleware.grouper.Field
public class Field
Schema specification for a Group attribute or list. Reference to members list is: Group.getDefaultList()
Field Summary | |
---|---|
static String |
COLUMN_FIELD_UUID
uuid col in db |
static String |
COLUMN_OLD_FIELD_UUID
old uuid id col for id conversion |
static String |
COLUMN_OLD_ID
old id col for id conversion |
static String |
FIELD_DB_VERSION
constant for field name for: dbVersion |
static String |
FIELD_GROUP_TYPE_UUID
constant for field name for: groupTypeUUID |
static String |
FIELD_IS_NULLABLE
constant for field name for: isNullable |
static String |
FIELD_NAME
constant for field name for: name |
static String |
FIELD_READ_PRIVILEGE
constant for field name for: readPrivilege |
static String |
FIELD_TYPE
constant for field name for: type |
static String |
FIELD_UUID
constant for field name for: uuid |
static String |
FIELD_WRITE_PRIVILEGE
constant for field name for: writePrivilege |
static String |
PROPERTY_UUID
constant for property name for: uuid |
static long |
serialVersionUID
|
static String |
TABLE_GROUPER_FIELDS
table name for fields |
Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI |
---|
COLUMN_HIBERNATE_VERSION_NUMBER, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER |
Fields inherited from interface org.hibernate.classic.Lifecycle |
---|
NO_VETO, VETO |
Constructor Summary | |
---|---|
Field()
|
Method Summary | |
---|---|
Field |
clone()
deep clone the fields in this object |
Field |
dbVersion()
save the state when retrieving from DB |
Set<String> |
dbVersionDifferentFields()
note, these are massaged so that name, extension, etc look like normal fields. |
void |
dbVersionReset()
take a snapshot of the data since this is what is in the db |
boolean |
equals(Object other)
|
static String |
fieldNames(Collection<Field> collection)
print out a collection of fields |
String |
getContextId()
context id of the transaction |
GroupType |
getGroupType()
|
String |
getGroupTypeUuid()
|
boolean |
getIsNullable()
|
String |
getName()
|
Privilege |
getReadPriv()
|
String |
getReadPrivilege()
|
boolean |
getRequired()
|
FieldType |
getType()
|
String |
getTypeString()
|
String |
getUuid()
|
Privilege |
getWritePriv()
|
String |
getWritePrivilege()
|
int |
hashCode()
|
boolean |
isAttributeDefListField()
see if this is a list of members field for attributeDefs |
boolean |
isAttributeName()
see if this field is an attribute name |
boolean |
isGroupListField()
see if this is a list of members field for groups |
boolean |
isStemListField()
see if this is a list of members field for stems |
void |
onPostDelete(HibernateSession hibernateSession)
after a delete occurs |
void |
onPostSave(HibernateSession hibernateSession)
after a save (insert) occurs |
void |
onPostUpdate(HibernateSession hibernateSession)
after an update occurs |
void |
onPreDelete(HibernateSession hibernateSession)
before a delete (insert) occurs |
void |
onPreSave(HibernateSession hibernateSession)
before a save (insert) occurs |
void |
onPreUpdate(HibernateSession hibernateSession)
before an update occurs |
void |
setContextId(String contextId1)
context id of the transaction |
void |
setGroupTypeUuid(String groupTypeUUID)
|
void |
setIsNullable(boolean isNullable)
|
void |
setName(String name)
|
void |
setReadPrivilege(Privilege readPrivilege)
|
void |
setReadPrivilege(String readPrivilege)
|
void |
setType(FieldType type)
|
void |
setTypeString(String type)
|
void |
setUuid(String uuid)
|
void |
setWritePrivilege(Privilege writePrivilege)
|
void |
setWritePrivilege(String writePrivilege)
|
void |
store()
store this object to the DB. |
String |
toString()
|
void |
xmlCopyBusinessPropertiesToExisting(Field existingRecord)
copy business (non update) properties to an existing record |
boolean |
xmlDifferentBusinessProperties(Field other)
see if the non update cols are different (e.g. |
boolean |
xmlDifferentUpdateProperties(Field other)
see if the update cols are different (e.g. |
String |
xmlGetId()
set id key in db |
Field |
xmlRetrieveByIdOrKey()
retrieve from db by id or key. |
Field |
xmlSaveBusinessProperties(Field existingRecord)
save the business properties (not update properties) |
void |
xmlSaveUpdateProperties()
save the udpate properties (e.g. |
void |
xmlSetId(String theId)
set id key in db |
XmlExportField |
xmlToExportField(GrouperVersion grouperVersion)
convert to xml bean for export |
String |
xmlToString()
convert to string for log |
Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI |
---|
dbVersionClear, dbVersionIsDifferent, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onSave, onUpdate, setHibernateVersionNumber |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String TABLE_GROUPER_FIELDS
public static final String COLUMN_FIELD_UUID
public static final String COLUMN_OLD_ID
public static final String COLUMN_OLD_FIELD_UUID
public static final String FIELD_DB_VERSION
public static final String FIELD_GROUP_TYPE_UUID
public static final String FIELD_IS_NULLABLE
public static final String FIELD_NAME
public static final String FIELD_READ_PRIVILEGE
public static final String FIELD_TYPE
public static final String FIELD_UUID
public static final String FIELD_WRITE_PRIVILEGE
public static final String PROPERTY_UUID
public static final long serialVersionUID
Constructor Detail |
---|
public Field()
Method Detail |
---|
public static String fieldNames(Collection<Field> collection)
collection
-
public String getContextId()
public void setContextId(String contextId1)
setContextId
in interface GrouperHasContext
contextId1
- public GroupType getGroupType() throws IllegalStateException
IllegalStateException
public boolean isStemListField()
public boolean isAttributeDefListField()
public boolean isGroupListField()
public FieldType getType()
public Privilege getReadPriv()
public boolean getRequired()
public Privilege getWritePriv()
public boolean equals(Object other)
equals
in class Object
other
-
public String getGroupTypeUuid()
public boolean getIsNullable()
public String getName()
public String getReadPrivilege()
public String getTypeString()
public String getUuid()
public String getWritePrivilege()
public int hashCode()
hashCode
in class Object
Object.hashCode()
public void setGroupTypeUuid(String groupTypeUUID)
groupTypeUUID
- public void setIsNullable(boolean isNullable)
isNullable
- public void setName(String name)
name
- public void setReadPrivilege(Privilege readPrivilege)
readPrivilege
- public void setReadPrivilege(String readPrivilege)
readPrivilege
- public void setType(FieldType type)
type
- public void setTypeString(String type)
type
- public boolean isAttributeName()
public void setUuid(String uuid)
uuid
- public void setWritePrivilege(Privilege writePrivilege)
writePrivilege
- public void setWritePrivilege(String writePrivilege)
writePrivilege
- public String toString()
toString
in class Object
public void onPostDelete(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostDelete
in interface HibGrouperLifecycle
onPostDelete
in class GrouperAPI
GrouperAPI.onPostDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPostSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostSave
in interface HibGrouperLifecycle
onPostSave
in class GrouperAPI
GrouperAPI.onPostSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPostUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostUpdate
in interface HibGrouperLifecycle
onPostUpdate
in class GrouperAPI
GrouperAPI.onPostUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPreDelete(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreDelete
in interface HibGrouperLifecycle
onPreDelete
in class GrouperAPI
GrouperAPI.onPreDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPreSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreSave
in interface HibGrouperLifecycle
onPreSave
in class GrouperAPI
GrouperAPI.onPreSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPreUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreUpdate
in interface HibGrouperLifecycle
onPreUpdate
in class GrouperAPI
GrouperAPI.onPreUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public Field dbVersion()
dbVersion
in class GrouperAPI
public Set<String> dbVersionDifferentFields()
dbVersionDifferentFields
in class GrouperAPI
GrouperAPI.dbVersionDifferentFields()
public void dbVersionReset()
dbVersionReset
in class GrouperAPI
public Field clone()
clone
in interface GrouperCloneable
clone
in class GrouperAPI
Object.clone()
public void store()
public void xmlCopyBusinessPropertiesToExisting(Field existingRecord)
XmlImportableBase
xmlCopyBusinessPropertiesToExisting
in interface XmlImportableBase<Field>
XmlImportableBase.xmlCopyBusinessPropertiesToExisting(java.lang.Object)
public boolean xmlDifferentBusinessProperties(Field other)
XmlImportableBase
xmlDifferentBusinessProperties
in interface XmlImportableBase<Field>
other
- the one to compare with
XmlImportableBase.xmlDifferentBusinessProperties(java.lang.Object)
public boolean xmlDifferentUpdateProperties(Field other)
XmlImportableBase
xmlDifferentUpdateProperties
in interface XmlImportableBase<Field>
other
- the one to compare with
XmlImportableBase.xmlDifferentUpdateProperties(java.lang.Object)
public Field xmlRetrieveByIdOrKey()
XmlImportable
xmlRetrieveByIdOrKey
in interface XmlImportable<Field>
XmlImportable.xmlRetrieveByIdOrKey()
public Field xmlSaveBusinessProperties(Field existingRecord)
XmlImportableBase
xmlSaveBusinessProperties
in interface XmlImportableBase<Field>
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
XmlImportableBase.xmlSaveBusinessProperties(java.lang.Object)
public void xmlSaveUpdateProperties()
XmlImportableBase
xmlSaveUpdateProperties
in interface XmlImportableBase<Field>
XmlImportableBase.xmlSaveUpdateProperties()
public XmlExportField xmlToExportField(GrouperVersion grouperVersion)
grouperVersion
-
public String xmlGetId()
XmlImportableBase
xmlGetId
in interface XmlImportableBase<Field>
XmlImportableBase.xmlGetId()
public void xmlSetId(String theId)
XmlImportableBase
xmlSetId
in interface XmlImportableBase<Field>
XmlImportableBase.xmlSetId(java.lang.String)
public String xmlToString()
XmlImportableBase
xmlToString
in interface XmlImportableBase<Field>
XmlImportableBase.xmlToString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |