Subversion Repositories XServices

Rev

Rev 6 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 brianR 1
/*
2
 *   Copyright 2010 Brian Rosenberger (Brutex Network)
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 net.brutex.xservices.types;
18
 
19
import javax.xml.bind.annotation.XmlElement;
20
import javax.xml.bind.annotation.XmlType;
10 brianR 21
import net.brutex.xservices.util.BrutexNamespaces;
6 brianR 22
 
23
/**
24
 *
25
 * @author Brian Rosenberger, bru@brutex.de
26
 */
10 brianR 27
@XmlType(namespace=BrutexNamespaces.WS_XSERVICES, name="ReturnCodeType")
6 brianR 28
public class ReturnCode {
29
 
10 brianR 30
    /**
31
     * Numeric return code.
32
     *
33
     * The numeric return code of the last operation on the underlying operation
34
     * systen (OS). In general the return code indicates the failure or success
35
     * of a command. Which value indicates success is dependent on the OS, most
36
     * linux based systems use "0" for success.
37
     */
38
    @XmlElement(required=true, nillable=false)
39
    public int returnCode=0;
6 brianR 40
 
10 brianR 41
    /**
42
     * Standard Out as provided by the OS.
43
     *
44
     * The stdOut given by the last operation (if any).
45
     */
46
    @XmlElement(name="stdOut", nillable=false)
47
    public String stdOut="";
6 brianR 48
 
10 brianR 49
    /**
50
     * The Standard Error as provided by the OS.
51
     *
52
     * The stdErr given by the last operation (if any). The presents of any
53
     * value here ususally indicates that a failure has occured.
54
     */
55
    @XmlElement(name="stdErr", nillable=false)
56
    public String stdErr="";
57
 
58
    /**
59
     * Create a new ReturnCode default constructor.
60
     */
6 brianR 61
    public ReturnCode() {
62
    }
63
 
10 brianR 64
    /**
65
     * Create a new ReturnCode.
66
     *
67
     * @param returnCode    return code integer value
68
     * @param stdOut        standard out string
69
     * @param stdErr        standard error string
70
     */
6 brianR 71
    public ReturnCode(int returnCode, String stdOut, String stdErr) {
72
        this.returnCode = returnCode;
73
        this.stdOut = stdOut;
74
        this.stdErr = stdErr;
75
    }
76
}