/*
 * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
 * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
 * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
 * compliance with the Licence. You may obtain a copy of the Licence at:
 * https://joinup.ec.europa.eu/news/understanding-eupl-v12
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the Licence
 * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence for the specific language governing permissions and limitations under
 * the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text file for details on the
 * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
 * works that you distribute must include a readable copy of the "NOTICE" text file.
*/

package at.gv.egiz.eaaf.modules.pvp2.api.reqattr;

import java.util.List;

import javax.xml.namespace.QName;

import at.gv.egiz.eaaf.modules.pvp2.PvpConstants;

import org.opensaml.core.xml.AttributeExtensibleXMLObject;
import org.opensaml.core.xml.XMLObject;
import org.opensaml.core.xml.schema.XSBooleanValue;
import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.saml2.metadata.RequestedAttribute;

public interface EaafRequestedAttribute extends SAMLObject, AttributeExtensibleXMLObject,
    RequestedAttribute {

  /** Element local name. */
  String DEF_LOCAL_NAME = "RequestedAttribute";

  /** Local name of the XSI type. */
  String TYPE_LOCAL_NAME = "RequestedAttributeAbstractType";

  /** Default element name. */
  QName DEFAULT_ELEMENT_NAME =
      new QName(PvpConstants.EIDAT10_SAML_NS, DEF_LOCAL_NAME, PvpConstants.EIDAT10_PREFIX);

  /** QName of the XSI type. */
  QName TYPE_NAME =
      new QName(PvpConstants.EIDAT10_SAML_NS, TYPE_LOCAL_NAME, PvpConstants.EIDAT10_PREFIX);

  /** NAME_ATTRIB_NAME attribute name. */
  String NAME_ATTRIB_NAME = "Name";

  /** NAME_FORMAT_ATTRIB_NAME attribute name. */
  String NAME_FORMAT_ATTR = "NameFormat";

  /** IS_REQUIRED_ATTRIB_NAME attribute name. */
  String IS_REQUIRED_ATTR = "isRequired";

  /** FRIENDLY_NAME_ATTRIB_NAME attribute name. */
  String FRIENDLY_NAME_ATT = "FriendlyName";

  /** Unspecified attribute format ID. */
  String UNSPECIFIED = "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified";

  /** URI reference attribute format ID. */
  String URI_REFERENCE = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri";

  /** Basic attribute format ID. */
  String BASIC = "urn:oasis:names:tc:SAML:2.0:attrname-format:basic";

  /**
   * Gets the name.
   *
   * @return the name
   */
  @Override
  String getName();

  /**
   * Sets the name.
   *
   * @param name the new name
   */
  @Override
  void setName(String name);

  /**
   * Gets the name format.
   *
   * @return the name format
   */
  @Override
  String getNameFormat();

  /**
   * Sets the name format.
   *
   * @param nameFormat the new name format
   */
  @Override
  void setNameFormat(String nameFormat);

  /**
   * Gets the friendly name.
   *
   * @return the friendly name
   */
  @Override
  String getFriendlyName();

  /**
   * Sets the friendly name.
   *
   * @param friendlyName the new friendly name
   */
  @Override
  void setFriendlyName(String friendlyName);

  /**
   * Gets the checks if is required xs boolean.
   *
   * @return the checks if is required xs boolean
   */
  String getIsRequiredXsBoolean();

  @Override
  void setIsRequired(Boolean aboolean);

  @Override
  void setIsRequired(XSBooleanValue xsBooleanValue);

  /**
   * Sets the checks if is required.
   *
   * @param newIsRequired the new checks if is required
   */
  void setIsRequired(String newIsRequired);

  /**
   * Gets the attribute values.
   *
   * @return the attribute values
   */
  @Override
  List<XMLObject> getAttributeValues();

  @Override
  XSBooleanValue isRequiredXSBoolean();

}