View Javadoc

1   /*
2    * Copyright 2008 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.xml.schema;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.joda.time.DateTime;
22  import org.joda.time.format.DateTimeFormatter;
23  import org.opensaml.xml.util.XMLConstants;
24  import org.opensaml.xml.validation.ValidatingXMLObject;
25  
26  /**
27   * XMLObject that represents an XML Schema dateTime.
28   */
29  public interface XSDateTime extends ValidatingXMLObject {
30  
31      /** Local name of the XSI type. */
32      public static final String TYPE_LOCAL_NAME = "dateTime"; 
33          
34      /** QName of the XSI type. */
35      public static final QName TYPE_NAME = new QName(XMLConstants.XSD_NS, TYPE_LOCAL_NAME, XMLConstants.XSD_PREFIX);
36      
37      /**
38       * Gets the dateTime value.
39       * 
40       * @return the dateTime value
41       */
42      public DateTime getValue();
43      
44      /**
45       * Sets the dateTime value.
46       * 
47       * @param newValue the dateTime value
48       */
49      public void setValue(DateTime newValue);
50      
51      /**
52       * Get the {@link DateTimeFormatter} to be used when stringifying
53       * the {@link DateTime} value.
54       * 
55       * <p>Defaults to the formatter constructed by calling: 
56       * <code>org.joda.time.format.ISODateTimeFormat.dateTime().withChronology(org.joda.time.chrono.ISOChronology.getInstanceUTC()</code>
57       * </p>
58       * 
59       * @return the currently configured formatter
60       */
61      public DateTimeFormatter getDateTimeFormatter();
62      
63      /**
64       * Set the {@link DateTimeFormatter} to be used when stringifying
65       * the {@link DateTime} value.
66       * 
67       * <p>Defaults to the formatter constructed by calling: 
68       * <code>org.joda.time.format.ISODateTimeFormat.dateTime().withChronology(org.joda.time.chrono.ISOChronology.getInstanceUTC()</code>
69       * </p>
70       * 
71       * @param newFormatter the new formatter
72       */
73      public void setDateTimeFormatter(DateTimeFormatter newFormatter);
74  }