001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2012-2015 ForgeRock AS
026 */
027package org.opends.server.schema;
028
029import static org.opends.server.schema.SchemaConstants.*;
030
031import org.forgerock.opendj.ldap.schema.Schema;
032import org.forgerock.opendj.ldap.schema.Syntax;
033import org.opends.server.admin.std.server.AttributeSyntaxCfg;
034import org.opends.server.api.AttributeSyntax;
035
036/**
037 * This class defines the delivery method attribute syntax.  This contains one
038 * or more of a fixed set of values.  If there are multiple values, then they
039 * are separated by spaces with a dollar sign between them.  The allowed values
040 * include:
041 *
042 * <UL>
043 *   <LI>any</LI>
044 *   <LI>mhs</LI>
045 *   <LI>physical</LI>
046 *   <LI>telex</LI>
047 *   <LI>teletex</LI>
048 *   <LI>g3fax</LI>
049 *   <LI>g4fax</LI>
050 *   <LI>ia5</LI>
051 *   <LI>videotex</LI>
052 *   <LI>telephone</LI>
053 * </UL>
054 */
055public class DeliveryMethodSyntax
056       extends AttributeSyntax<AttributeSyntaxCfg>
057{
058
059  /**
060   * Creates a new instance of this syntax.  Note that the only thing that
061   * should be done here is to invoke the default constructor for the
062   * superclass.  All initialization should be performed in the
063   * <CODE>initializeSyntax</CODE> method.
064   */
065  public DeliveryMethodSyntax()
066  {
067    super();
068  }
069
070  /** {@inheritDoc} */
071  @Override
072  public Syntax getSDKSyntax(Schema schema)
073  {
074    return schema.getSyntax(SchemaConstants.SYNTAX_DELIVERY_METHOD_OID);
075  }
076
077  /**
078   * Retrieves the common name for this attribute syntax.
079   *
080   * @return  The common name for this attribute syntax.
081   */
082  @Override
083  public String getName()
084  {
085    return SYNTAX_DELIVERY_METHOD_NAME;
086  }
087
088  /**
089   * Retrieves the OID for this attribute syntax.
090   *
091   * @return  The OID for this attribute syntax.
092   */
093  @Override
094  public String getOID()
095  {
096    return SYNTAX_DELIVERY_METHOD_OID;
097  }
098
099  /**
100   * Retrieves a description for this attribute syntax.
101   *
102   * @return  A description for this attribute syntax.
103   */
104  @Override
105  public String getDescription()
106  {
107    return SYNTAX_DELIVERY_METHOD_DESCRIPTION;
108  }
109}
110