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  package org.opensaml.ws.wssecurity;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.joda.time.DateTime;
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  import org.opensaml.xml.schema.XSString;
24  
25  /**
26   * Interface for elements of complex type AttributedDateTime.
27   * 
28   */
29  public interface AttributedDateTime extends XSString, IdBearing, AttributeExtensibleXMLObject, WSSecurityObject  {
30  
31      /** Local name of the XSI type. */
32      public static final String TYPE_LOCAL_NAME = "AttributedDateTime"; 
33          
34      /** QName of the XSI type. */
35      public static final QName TYPE_NAME = 
36          new QName(WSSecurityConstants.WSU_NS, TYPE_LOCAL_NAME, WSSecurityConstants.WSU_PREFIX);
37      
38      /** Default DateTime format. */
39      public static final String DEFAULT_DATETIME_FORMAT= "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
40  
41      /**
42       * Returns the DateTime content or attribute value.
43       * 
44       * @return the {@link DateTime} object.
45       */
46      public DateTime getDateTime();
47  
48      /**
49       * Sets the DateTime content or attribute value.
50       * 
51       * @param dateTime
52       *            the {@link DateTime} object to set.
53       */
54      public void setDateTime(DateTime dateTime);
55  }