org.openmdx.security.realm1.cci2.Permission Maven / Gradle / Ivy

Go to download
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Name: $Id: AbstractMapper.java,v 1.10 2011/07/08 13:20:51 wfro Exp $
// Generated by: openMDX Java Mapper
// Date: Mon Mar 09 17:05:02 CET 2020
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.security.realm1.cci2;

/**
 * Class Permission
 */
public interface Permission
  extends org.openmdx.base.cci2.BasicObject{

// ----------------------------------------------------------------------------
// Instance/AttributeGetSet
// ----------------------------------------------------------------------------
  /**
   * Retrieves a set containing all the elements for the attribute action.
   * @return A set containing all elements for this attribute.
   */
  public java.util.Set getAction(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSetSet
// ----------------------------------------------------------------------------
  /**
   * Clears action and adds the given value(s).
   * 
   * This method is equivalent to
   *   set.clear();
   *   for(java.lang.String e : action){
   *     set.add(e);
   *   }
   * 
   * @param action value(s) to be added to action
   */
  public void setAction(
    java.lang.String... action
  );

// ----------------------------------------------------------------------------
// 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/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 Attribute'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 Attribute'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 privilege.
   * @return The non-null value for this reference.
   */
  public org.openmdx.security.realm1.cci2.Privilege getPrivilege(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the reference privilege.
   * @param privilege The new non-null value for this reference.
   */
  public void setPrivilege(
    org.openmdx.security.realm1.cci2.Privilege privilege
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference realm.
   * @return The non-null value for this reference.
   */
  public org.openmdx.security.realm1.cci2.Role getRealm(
  );

// ----------------------------------------------------------------------------
// 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 Role's identity
     * @return the parent object's identity
     */
    public org.openmdx.security.realm1.cci2.Role.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();

  }

}