View Javadoc

1   /*
2    * Copyright 2009 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.ws.wspolicy;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.schema.XSBooleanValue;
22  
23  /**
24   * Interface for element having a <code>@wsp:Optional</code> attribute.
25   */
26  public interface OptionalBearing {
27      
28      /** The wsp:@Optional attribute local name. */
29      public static final String WSP_OPTIONAL_ATTR_LOCAL_NAME = "Optional";
30  
31      /** The wsp:@Optional qualified attribute name. */
32      public static final QName WSP_OPTIONAL_ATTR_NAME =
33          new QName(WSPolicyConstants.WSP_NS, WSP_OPTIONAL_ATTR_LOCAL_NAME, WSPolicyConstants.WSP_PREFIX);
34      
35      /**
36       * Get the attribute value.
37       * 
38       * @return return the attribute value
39       */
40      public Boolean isWSP12Optional();
41      
42      /**
43       * Get the attribute value.
44       * 
45       * @return return the attribute value
46       */
47      public XSBooleanValue isWSP12OptionalXSBoolean();
48      
49      /**
50       * Set the attribute value.
51       * 
52       * @param newOptional the new attribute value
53       */
54      public void setWSP12Optional(Boolean newOptional);
55      
56      /**
57       * Set the attribute value.
58       * 
59       * @param newOptional the new attribute value
60       */
61      public void setWSP12Optional(XSBooleanValue newOptional);
62  
63  }