org.openmdx.security.realm1.cci2.Principal Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Generated by org.openmdx.application.mof.mapping.java.InstanceMapper 2.17.7
// Generated at 2020-11-27T16:04:30.454Z
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.security.realm1.cci2;
/**
* Class Principal
*/
public interface Principal
extends org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nNoQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the Collection of objects referenced by authCredential.
* @return The Collection of referenced objects.
*/
public java.util.List getAuthCredential(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference credential.
* @return The – possibly null – value for this reference.
*/
public org.openmdx.security.realm1.cci2.Credential getCredential(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference credential.
* @param credential The new – possibly null – value for this reference.
*/
public void setCredential(
org.openmdx.security.realm1.cci2.Credential credential
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute description.
* @return The possibly null value for attribute description.
*/
public java.lang.String getDescription(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute description.
* @param description The possibly null new value for attribute description.
*/
public void setDescription(
java.lang.String description
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute disabled.
* @return The possibly null value for attribute disabled.
*/
public java.lang.Boolean isDisabled(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute disabled.
* @param disabled The possibly null new value for attribute disabled.
*/
public void setDisabled(
java.lang.Boolean disabled
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nNoQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the Collection of objects referenced by isMemberOf.
* @return The Collection of referenced objects.
*/
public java.util.List getIsMemberOf(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGetList
// ----------------------------------------------------------------------------
/**
* Retrieves a list containing all the elements for the attribute localizedDescription.
* @return A list containing all elements for this attribute.
*/
public java.util.List getLocalizedDescription(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSetList
// ----------------------------------------------------------------------------
/**
* Clears localizedDescription and adds the given value(s).
*
* This method is equivalent to
* list.clear();
* for(java.lang.String e : localizedDescription){
* list.add(e);
* }
*
* @param localizedDescription value(s) to be added to localizedDescription
*/
public void setLocalizedDescription(
java.lang.String... localizedDescription
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute name.
*
* This attribute is usually derived from the Principal's ObjectId.
* @return The non-null value for attribute name.
*/
public java.lang.String getName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute name.
*
* This attribute is usually derived from the Principal's ObjectId.
* @param name The non-null new value for attribute name.
*/
public void setName(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference realm.
* @return The non-null value for this reference.
*/
public org.openmdx.security.realm1.cci2.Realm getRealm(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference subject.
* @return The – possibly null – value for this reference.
*/
public org.openmdx.security.realm1.cci2.Subject getSubject(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference subject.
* @param subject The new – possibly null – value for this reference.
*/
public void setSubject(
org.openmdx.security.realm1.cci2.Subject subject
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute type.
* @return The possibly null value for attribute type.
*/
public java.lang.Short getType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute type.
* @param type The possibly null new value for attribute type.
*/
public void setType(
java.lang.Short type
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the Realm's identity
* @return the parent object's identity
*/
public org.openmdx.security.realm1.cci2.Realm.Identity getRealm();
/**
* Tells whether the id value is persistent or reassignable.
* @return PERSISTENT or REASSIGNABLE
*/
public org.oasisopen.cci2.QualifierType getIdType();
/**
* The id value
* @return the id value
*/
public java.lang.String getId();
}
}