View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.orchestra.conversation.jsf.components;
21  
22  import javax.faces.component.UIComponent;
23  
24  /**
25   * End a conversation.
26   * <p>
27   * When a conversation ends, all objects stored in that conversation are discarded.
28   *
29   * @see org.apache.myfaces.orchestra.conversation.jsf.components.UIEndConversation
30   */
31  public class EndConversationTag extends AbstractConversationTag
32  {
33      private String onOutcome;
34      private String errorOutcome;
35  
36      public String getComponentType()
37      {
38          return UIEndConversation.COMPONENT_TYPE;
39      }
40  
41      protected void setProperties(UIComponent component)
42      {
43          super.setProperties(component);
44  
45          setStringProperty(component, "onOutcome", getOnOutcome());
46          setStringProperty(component, "errorOutcome", getErrorOutcome());
47      }
48  
49      public String getOnOutcome()
50      {
51          return onOutcome;
52      }
53  
54      public void setOnOutcome(String onOutcome)
55      {
56          this.onOutcome = onOutcome;
57      }
58  
59      public String getErrorOutcome()
60      {
61          return errorOutcome;
62      }
63  
64      public void setErrorOutcome(String errorOutcome)
65      {
66          this.errorOutcome = errorOutcome;
67      }
68  }