org.jboss.shrinkwrap.descriptor.api.ejbjar30.SecurityIdentityType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.ejbjar30; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee5.RunAsType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeSecurityIdentityCommonType;

import org.jboss.shrinkwrap.descriptor.api.javaee5.RunAsType;/**
 * This interface defines the contract for the  security-identityType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface SecurityIdentityType extends Child, 
    JavaeeSecurityIdentityCommonType,
    RunAsType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SecurityIdentityType ElementName: xsd:string ElementType : description
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing description elements, 
    * a new description element 
    * @param values list of description objects 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType removeAllDescription();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SecurityIdentityType ElementName: javaee:emptyType ElementType : use-caller-identity
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the use-caller-identity element 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType useCallerIdentity();

   /**
    * Removes the use-caller-identity element 
    * @return the current instance of SecurityIdentityType 
    */
   public Boolean isUseCallerIdentity();

   /**
    * Removes the use-caller-identity element 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType removeUseCallerIdentity();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SecurityIdentityType ElementName: javaee:run-asType ElementType : run-as
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new run-as element with the given value will be created.
    * Otherwise, the existing run-as element will be returned.
    * @return  a new or existing instance of RunAsType> 
    */
   public RunAsType> getOrCreateRunAs();

   /**
    * Removes the run-as element 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType removeRunAs();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SecurityIdentityType ElementName: xsd:ID ElementType : id
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the id attribute
    * @param id the value for the attribute id 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType id(String id);

   /**
    * Returns the id attribute
    * @return the value defined for the attribute id 
    */
   public String getId();

   /**
    * Removes the id attribute 
    * @return the current instance of SecurityIdentityType 
    */
   public SecurityIdentityType removeId();
}