View Javadoc

1   /*
2    * Copyright 2008 Members of the EGEE Collaboration.
3    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.opensaml.xacml.policy;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xacml.XACMLConstants;
23  import org.opensaml.xacml.XACMLObject;
24  
25  /** XACML VariableDefinition schema type. */
26  public interface VariableDefinitionType extends XACMLObject {
27  
28      /** Local name of the element. */
29      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "VariableDefinition";
30  
31      /** Default element name. */
32      public static final QName DEFAULT_ELEMENT_NAME = new QName(XACMLConstants.XACML20_NS,
33              DEFAULT_ELEMENT_LOCAL_NAME, XACMLConstants.XACML_PREFIX);
34  
35      /** Local name of the XSI type. */
36      public static final String TYPE_LOCAL_NAME = "VariableDefinitionType";
37  
38      /** QName of the XSI type. */
39      public static final QName TYPE_NAME = new QName(XACMLConstants.XACML20_NS, TYPE_LOCAL_NAME,
40              XACMLConstants.XACML_PREFIX);
41  
42      /** Name of VariableId attribute. */
43      public static final String VARIABLE_ID_ATTRIB_NAME = "VariableId";
44  
45      /**
46       * Gets the expression for this definition.
47       * 
48       * @return expression for this definition
49       */
50      public ExpressionType getExpression();
51  
52      /**
53       * Gets the ID of this defined variable.
54       * 
55       * @return ID of this defined variable
56       */
57      public String getVariableId();
58  
59      /**
60       * Sets the ID of this defined variable.
61       * 
62       * @param id ID of this defined variable
63       */
64      public void setVariableId(String id);
65  }