|
||||||||||
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 java.lang.String |
COLUMN_CONTEXT_ID
col |
static java.lang.String |
COLUMN_FIELD_UUID
uuid col in db |
static java.lang.String |
COLUMN_ID
col |
static java.lang.String |
COLUMN_NAME
col |
static java.lang.String |
COLUMN_OLD_FIELD_UUID
old uuid id col for id conversion |
static java.lang.String |
COLUMN_OLD_ID
old id col for id conversion |
static java.lang.String |
COLUMN_READ_PRIVILEGE
col |
static java.lang.String |
COLUMN_TYPE
col |
static java.lang.String |
COLUMN_WRITE_PRIVILEGE
col |
static java.lang.String |
FIELD_DB_VERSION
constant for field name for: dbVersion |
static java.lang.String |
FIELD_NAME
constant for field name for: name |
static java.lang.String |
FIELD_NAME_ADMINS
field name for admins |
static java.lang.String |
FIELD_NAME_ATTR_ADMINS
field name for attr admins |
static java.lang.String |
FIELD_NAME_ATTR_DEF_ATTR_READERS
field name for attrDefAttrReaders |
static java.lang.String |
FIELD_NAME_ATTR_DEF_ATTR_UPDATERS
field name for attrDefAttrUpdaters |
static java.lang.String |
FIELD_NAME_ATTR_OPTINS
field name for attr optins |
static java.lang.String |
FIELD_NAME_ATTR_OPTOUTS
field name for attr optouts |
static java.lang.String |
FIELD_NAME_ATTR_READERS
field name for attr readers |
static java.lang.String |
FIELD_NAME_ATTR_UPDATERS
field name for attr updaters |
static java.lang.String |
FIELD_NAME_ATTR_VIEWERS
field name for attr viewers |
static java.lang.String |
FIELD_NAME_CREATORS
field name for creators |
static java.lang.String |
FIELD_NAME_GROUP_ATTR_READERS
field name for groupAttrReaders |
static java.lang.String |
FIELD_NAME_GROUP_ATTR_UPDATERS
field name for groupAttrUpdaters |
static java.lang.String |
FIELD_NAME_OPTINS
field name for optins |
static java.lang.String |
FIELD_NAME_OPTOUTS
field name for optouts |
static java.lang.String |
FIELD_NAME_READERS
field name for readers |
static java.lang.String |
FIELD_NAME_STEM_ADMINS
field name for stemAdmins |
static java.lang.String |
FIELD_NAME_STEM_ATTR_READERS
field name for stemAttrReaders |
static java.lang.String |
FIELD_NAME_STEM_ATTR_UPDATERS
field name for stemAttrUpdaters |
static java.lang.String |
FIELD_NAME_STEMMERS
field name for stemmers |
static java.lang.String |
FIELD_NAME_UPDATERS
field name for updaters |
static java.lang.String |
FIELD_NAME_VIEWERS
field name for viewers |
static java.lang.String |
FIELD_READ_PRIVILEGE
constant for field name for: readPrivilege |
static java.lang.String |
FIELD_TYPE
constant for field name for: type |
static java.lang.String |
FIELD_UUID
constant for field name for: uuid |
static java.lang.String |
FIELD_WRITE_PRIVILEGE
constant for field name for: writePrivilege |
static java.lang.String |
PROPERTY_UUID
constant for property name for: uuid |
static long |
serialVersionUID
|
static java.lang.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 | |
---|---|
static java.util.Collection<Field> |
calculateInheritedPrivileges(java.util.Collection<Field> fields,
boolean includeInheritedPrivileges)
see if there are inherited privileges to also include |
Field |
clone()
deep clone the fields in this object |
int |
compareTo(Field that)
|
Field |
dbVersion()
save the state when retrieving from DB |
java.util.Set<java.lang.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(java.lang.Object other)
|
static java.lang.String |
fieldNames(java.util.Collection<Field> collection)
print out a collection of fields |
java.lang.String |
getContextId()
context id of the transaction |
GroupType |
getGroupType()
|
GroupType |
getGroupType(boolean exceptionIfNoGroupType)
|
java.lang.String |
getId()
return the uuid |
java.util.Collection<Field> |
getImpliedFields()
get the fields that this field implies by inheritance |
java.lang.String |
getName()
|
Privilege |
getReadPriv()
|
java.lang.String |
getReadPrivilege()
|
FieldType |
getType()
|
java.lang.String |
getTypeString()
|
java.lang.String |
getUuid()
|
Privilege |
getWritePriv()
|
java.lang.String |
getWritePrivilege()
|
int |
hashCode()
|
static Field |
internal_addField(GrouperSession s,
java.lang.String name,
FieldType type,
Privilege read,
Privilege write,
boolean exceptionIfExists,
boolean updateIfExists,
boolean[] changedArray,
java.lang.String uuid)
add a field if it is not already there |
boolean |
isAttributeDefListField()
see if this is a list of members field for attributeDefs |
boolean |
isAttributeName()
Deprecated. |
boolean |
isEntityListField()
see if this is a list of members field for groups |
boolean |
isGroupAccessField()
see if this is privilege field for groups |
boolean |
isGroupListField()
see if this is a list of members field for groups |
boolean |
isPrivilege()
|
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(java.lang.String contextId1)
context id of the transaction |
void |
setName(java.lang.String name)
|
void |
setReadPrivilege(Privilege readPrivilege)
|
void |
setReadPrivilege(java.lang.String readPrivilege)
|
void |
setType(FieldType type)
|
void |
setTypeString(java.lang.String type)
|
void |
setUuid(java.lang.String uuid)
|
void |
setWritePrivilege(Privilege writePrivilege)
|
void |
setWritePrivilege(java.lang.String writePrivilege)
|
void |
store()
store this object to the DB. |
java.lang.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. name) |
boolean |
xmlDifferentUpdateProperties(Field other)
see if the update cols are different (e.g. last updated) |
java.lang.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. last updated). |
void |
xmlSetId(java.lang.String theId)
set id key in db |
XmlExportField |
xmlToExportField(GrouperVersion grouperVersion)
convert to xml bean for export |
java.lang.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 java.lang.String FIELD_NAME_CREATORS
public static final java.lang.String FIELD_NAME_STEMMERS
public static final java.lang.String FIELD_NAME_VIEWERS
public static final java.lang.String FIELD_NAME_ATTR_VIEWERS
public static final java.lang.String FIELD_NAME_ADMINS
public static final java.lang.String FIELD_NAME_ATTR_ADMINS
public static final java.lang.String FIELD_NAME_READERS
public static final java.lang.String FIELD_NAME_ATTR_READERS
public static final java.lang.String FIELD_NAME_UPDATERS
public static final java.lang.String FIELD_NAME_ATTR_UPDATERS
public static final java.lang.String FIELD_NAME_OPTINS
public static final java.lang.String FIELD_NAME_ATTR_OPTINS
public static final java.lang.String FIELD_NAME_OPTOUTS
public static final java.lang.String FIELD_NAME_ATTR_OPTOUTS
public static final java.lang.String FIELD_NAME_GROUP_ATTR_READERS
public static final java.lang.String FIELD_NAME_GROUP_ATTR_UPDATERS
public static final java.lang.String FIELD_NAME_ATTR_DEF_ATTR_READERS
public static final java.lang.String FIELD_NAME_ATTR_DEF_ATTR_UPDATERS
public static final java.lang.String FIELD_NAME_STEM_ATTR_READERS
public static final java.lang.String FIELD_NAME_STEM_ATTR_UPDATERS
public static final java.lang.String FIELD_NAME_STEM_ADMINS
public static final java.lang.String COLUMN_ID
public static final java.lang.String COLUMN_NAME
public static final java.lang.String COLUMN_READ_PRIVILEGE
public static final java.lang.String COLUMN_TYPE
public static final java.lang.String COLUMN_WRITE_PRIVILEGE
public static final java.lang.String COLUMN_CONTEXT_ID
public static final java.lang.String TABLE_GROUPER_FIELDS
public static final java.lang.String COLUMN_FIELD_UUID
public static final java.lang.String COLUMN_OLD_ID
public static final java.lang.String COLUMN_OLD_FIELD_UUID
public static final java.lang.String FIELD_DB_VERSION
public static final java.lang.String FIELD_NAME
public static final java.lang.String FIELD_READ_PRIVILEGE
public static final java.lang.String FIELD_TYPE
public static final java.lang.String FIELD_UUID
public static final java.lang.String FIELD_WRITE_PRIVILEGE
public static final java.lang.String PROPERTY_UUID
public static final long serialVersionUID
Constructor Detail |
---|
public Field()
Method Detail |
---|
public java.util.Collection<Field> getImpliedFields()
public boolean isPrivilege()
public java.lang.String getId()
public static java.util.Collection<Field> calculateInheritedPrivileges(java.util.Collection<Field> fields, boolean includeInheritedPrivileges)
public static java.lang.String fieldNames(java.util.Collection<Field> collection)
collection
-
public java.lang.String getContextId()
public void setContextId(java.lang.String contextId1)
setContextId
in interface GrouperHasContext
contextId1
- public boolean isStemListField()
public boolean isAttributeDefListField()
public boolean isGroupListField()
public boolean isGroupAccessField()
public boolean isEntityListField()
public FieldType getType()
public Privilege getReadPriv()
public Privilege getWritePriv()
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
-
public java.lang.String getName()
public java.lang.String getReadPrivilege()
public java.lang.String getTypeString()
public java.lang.String getUuid()
public java.lang.String getWritePrivilege()
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public void setName(java.lang.String name)
name
- public void setReadPrivilege(Privilege readPrivilege)
readPrivilege
- public void setReadPrivilege(java.lang.String readPrivilege)
readPrivilege
- public void setType(FieldType type)
type
- public void setTypeString(java.lang.String type)
type
- public boolean isAttributeName()
public void setUuid(java.lang.String uuid)
uuid
- public void setWritePrivilege(Privilege writePrivilege)
writePrivilege
- public void setWritePrivilege(java.lang.String writePrivilege)
writePrivilege
- public java.lang.String toString()
toString
in class java.lang.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 java.util.Set<java.lang.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 java.lang.String xmlGetId()
XmlImportableBase
xmlGetId
in interface XmlImportableBase<Field>
XmlImportableBase.xmlGetId()
public void xmlSetId(java.lang.String theId)
XmlImportableBase
xmlSetId
in interface XmlImportableBase<Field>
XmlImportableBase.xmlSetId(java.lang.String)
public java.lang.String xmlToString()
XmlImportableBase
xmlToString
in interface XmlImportableBase<Field>
XmlImportableBase.xmlToString()
public GroupType getGroupType(boolean exceptionIfNoGroupType)
exceptionIfNoGroupType
-
public GroupType getGroupType()
public int compareTo(Field that)
compareTo
in interface java.lang.Comparable<Field>
Comparable.compareTo(java.lang.Object)
public static Field internal_addField(GrouperSession s, java.lang.String name, FieldType type, Privilege read, Privilege write, boolean exceptionIfExists, boolean updateIfExists, boolean[] changedArray, java.lang.String uuid) throws InsufficientPrivilegeException, SchemaException
s
- name
- type
- read
- write
- exceptionIfExists
- updateIfExists
- changedArray
- is an array of 1 if you want to know if this method changed anything, else nulluuid
-
InsufficientPrivilegeException
SchemaException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |